BASIC INFORMATION
STANDARD INFORMATION
Name: pivotalservice (pivotal.pivotalservice)
Hint: A basic interface to the Pivotal Tracker API 
Last Modified: February 1, 2009 19:01:53 UTC
OTHER INFORMATION
OUTPUT: false
METHOD SUMMARY
PUBLIC METHODS
getReleases( numeric projectID )
Get just the Release type 'stories'
    return type: any
    [detail on: getReleases()]
getProject( numeric id )
Given a project ID, get a struct of the information about that project
    return type: any
    [detail on: getProject()]
init( string token [, boolean useSSL=false] [, string version=v2] )
    return type: any
    [detail on: init()]
getProjects( )
Returns a struct of project structs, keyed by ID (all projects associated with the authenticated token)
    return type: any
    [detail on: getProjects()]
getLabels( numeric projectID [, string filter=] )
Get all Labels given a Project ID as a struct, with all IDs of stories with that label in a struct, with the value being the priorityIndex for each story. Optionally pass a filter in the form of a Pivotal search string.
    return type: struct
    [detail on: getLabels()]
getStory( numeric projectID , numeric storyID )
Get a given story as a struct, given a projectID and a storyID
    return type: any
    [detail on: getStory()]
getStories( numeric projectID [, string filter=] )
Given a Project ID, get all the stories for that Project in a struct of structs, keyed by story ID. Optionally, pass a filter and/or pagination options to limit the result.
    return type: any
    [detail on: getStories()]
METHOD DETAILS
getReleases    [top]
Hint: Get just the Release type 'stories'
Access: public
Return Type: any
Output: false
Implemented In: pivotal.pivotalservice
Arguments:
projectID
Hint:
Type: numeric
Required: Yes
getProjects    [top]
Hint: Returns a struct of project structs, keyed by ID (all projects associated with the authenticated token)
Access: public
Return Type: any
Output: false
Implemented In: pivotal.pivotalservice
Arguments:
getStories    [top]
Hint: Given a Project ID, get all the stories for that Project in a struct of structs, keyed by story ID. Optionally, pass a filter and/or pagination options to limit the result.
Access: public
Return Type: any
Output: false
Implemented In: pivotal.pivotalservice
Arguments:
projectID
Hint:
Type: numeric
Required: Yes
filter
Hint: Optional search string, formatted exactly as it would be inside of Pivotal
Type: string
Required: No
Default:
init    [top]
Hint:
Access: public
Return Type: any
Output: false
Implemented In: pivotal.pivotalservice
Arguments:
token
Hint: Your API Token
Type: string
Required: Yes
useSSL
Hint: Boolean for whether we should use SSL in our requests
Type: boolean
Required: No
Default: false
version
Hint: The full string depicting the version of the API to use (by default, 'v2')
Type: string
Required: No
Default: v2
getLabels    [top]
Hint: Get all Labels given a Project ID as a struct, with all IDs of stories with that label in a struct, with the value being the priorityIndex for each story. Optionally pass a filter in the form of a Pivotal search string.
Access: public
Return Type: struct
Output: false
Implemented In: pivotal.pivotalservice
Arguments:
projectID
Hint:
Type: numeric
Required: Yes
filter
Hint: Optional search string, formatted exactly as it would be inside of Pivotal
Type: string
Required: No
Default:
getProject    [top]
Hint: Given a project ID, get a struct of the information about that project
Access: public
Return Type: any
Output: false
Implemented In: pivotal.pivotalservice
Arguments:
id
Hint:
Type: numeric
Required: Yes
getStory    [top]
Hint: Get a given story as a struct, given a projectID and a storyID
Access: public
Return Type: any
Output: false
Implemented In: pivotal.pivotalservice
Arguments:
projectID
Hint:
Type: numeric
Required: Yes
storyID
Hint:
Type: numeric
Required: Yes
This Document Created With CFCDocumenter by Nathan Dintenfass.
Unauthorized use of the content on this page is strictly prohibited.