Pivotal - Documentation

new Pivotal(apiToken)

Pivotal API Interface

Parameters:

Name	Type	Description
`apiToken`	string	Pivotal API Token

Source:

index.js, line 17

Methods

createLabel(projectId, name, callbackopt)

Create label

Parameters:

Name	Type	Attributes	Description
`projectId`	String		Pivotal project id
`name`	String		Name of label
`callback`	function	<optional>	function(error, label)

Source:

index.js, line 234

createStory(projectId, paramsopt, callbackopt)

Create new Pivotal story

Parameters:

Name	Type	Attributes	Description
`projectId`	String		Pivotal project id
`params`	Object	<optional>	Story parameters
`callback`	function	<optional>	function(error, story)

Source:

index.js, line 248

exportStories(stories, callbackopt)

Export stories from Pivotal

Parameters:

Name	Type	Attributes	Description
`stories`	Array.<String>		List of story id's
`callback`	function	<optional>	function(error, response)

Source:

index.js, line 171

getActivity(projectId, optionsopt, callbackopt, completedopt, offsetopt, limitopt)

Get paginated activity from project

Parameters:

Name	Type	Attributes	Description
`projectId`	String		Pivotal project id
`options`	Object	<optional>	Extra options
`callback`	function	<optional>	function(events, pagination, callback(error or true to stop pagination))
`completed`	function	<optional>	function(error)
`offset`	Integer	<optional>	Initial pagination offset
`limit`	Integer	<optional>	Pagination limit for each response

Source:

index.js, line 74

getComments(projectId, storyId, callbackopt)

Get comments from story

Parameters:

Name	Type	Attributes	Description
`projectId`	String		Pivotal project id
`storyId`	String		Pivotal story id
`callback`	function	<optional>	function(error, comments)

Source:

index.js, line 162

getCurrentIterations(projectId, callbackopt)

Get current iteration stories from project

Parameters:

Name	Type	Attributes	Description
`projectId`	String		Pivotal project id
`callback`	function	<optional>	function(error, iterations)

Source:

index.js, line 130

getIterations(projectId, optionsopt, callbackopt, completedopt, offsetopt, limitopt)

Get paginated iterations for project

Parameters:

Name	Type	Attributes	Description
`projectId`	String		Pivotal project id
`options`	Object	<optional>	Extra options
`callback`	function	<optional>	function(iterations, pagination, callback(error or true to stop pagination))
`completed`	function	<optional>	function(error)
`offset`	Integer	<optional>	Initial pagination offset
`limit`	Integer	<optional>	Pagination limit for each response

Source:

index.js, line 121

getLabels(projectId, callbackopt)

Get all labels in project

Parameters:

Name	Type	Attributes	Description
`projectId`	String		Pivotal project id
`callback`	function	<optional>	function(error, labels)

Source:

index.js, line 224

getMemberships(projectId, callbackopt)

Get memberships for project

Parameters:

Name	Type	Attributes	Description
`projectId`	String		Pivotal project id
`callback`	function	<optional>	function(error, memberships)

Source:

index.js, line 152

getMyActivity(callbackopt, optionsopt)

Get API token owner activity

Parameters:

Name	Type	Attributes	Description
`callback`	function	<optional>	function(error, events)
`options`	Object	<optional>	Extra options

Source:

index.js, line 96

getProjects(callbackopt)

Obtains list of projects

Parameters:

Name	Type	Attributes	Description
`callback`	function	<optional>	function(error, projects)

Source:

index.js, line 48

getStories(projectId, optionsopt, callbackopt, completedopt, offsetopt, limitopt)

Get paginated stories from project

Parameters:

Name	Type	Attributes	Description
`projectId`	String		Pivotal project id
`options`	Object	<optional>	Extra options
`callback`	function	<optional>	function(stories, pagination, callback(error or true to stop pagination))
`completed`	function	<optional>	function(error)
`offset`	Integer	<optional>	Initial pagination offset
`limit`	Integer	<optional>	Pagination limit for each response

Source:

index.js, line 61

getStory(storyId, callbackopt)

Obtains a story

Parameters:

Name	Type	Attributes	Description
`storyId`	String		Pivotal story id
`callback`	function	<optional>	function(error, response)

Source:

index.js, line 40

getStoryActivity(projectId, storyId, callbackopt, optionsopt)

Get activity for story

Parameters:

Name	Type	Attributes	Description
`projectId`	String		Pivotal project id
`storyId`	String		Pivotal story id
`callback`	function	<optional>	function(error, events)
`options`	Object	<optional>	Extra options

Source:

index.js, line 85

getTasks(projectId, storyId, callbackopt)

Get tasks for story

Parameters:

Name	Type	Attributes	Description
`projectId`	String		Pivotal project id
`storyId`	String		Pivotal story id
`callback`	function	<optional>	function(error, tasks)

Source:

index.js, line 108

postAttachment(projectId, storyId, filepath, type, comment, callbackopt)

Post attachment to story

Parameters:

Name	Type	Attributes	Description
`projectId`	String		Pivotal project id
`storyId`	String		Pivotal story id
`filepath`	String		Path of attachment
`type`	String		Content type of attachment
`comment`	String		Comment text
`callback`	function	<optional>	function(error, response)

Source:

index.js, line 188

updateStory(projectId, storyId, paramsopt, callbackopt)

Update a story

Parameters:

Name	Type	Attributes	Description
`projectId`	String		Pivotal project id
`storyId`	String		Pivotal story id
`params`	Object	<optional>	Extra parameters
`callback`	function	<optional>	function(error, response)

Source:

index.js, line 29