@datafire/pivotaltracker

Client library for Pivotal Tracker

Installation and Usage

npm install --save @datafire/pivotaltracker

let pivotaltracker = require('@datafire/pivotaltracker').create();

.then(data => {
  console.log(data);
});

Description

Access and manipulate agile project management data including projects, stories and tasks.

Actions

tokens.active.get

Returns an API token associated with the user. This method requires HTTP Basic authentication.

pivotaltracker.tokens.active.get(null, context)

Input

This action has no parameters

Output

Output schema unknown

tokens.active.post

Returns an API token associated with the user.

pivotaltracker.tokens.active.post({
  "username": "",
  "password": ""
}, context)

Input

• input object
  • username required string: The user's name.
  • password required string: The user's password.

Output

Output schema unknown

activities.get

Retrieves the recent activity of all your projects.

pivotaltracker.activities.get({}, context)

Input

• input object
  • limit integer: Limits the number of activity feed items. Note the default value is 10, and there is a upper cap of 100
  • occurred_since_date string: Restricts the activity feed to only those items that occurred after a supplied date (example format: 2009/12/18 21:00:00 UTC)
  • newer_than_version string: Restricts the activity feed to only those items that have a greater than supplied version

Output

Output schema unknown

projects.PROJECT_ID.activities.get

Retrieves the recent activity of a specific project.

pivotaltracker.projects.PROJECT_ID.activities.get({
  "PROJECT_ID": ""
}, context)

Input

• input object
  • limit integer: Limits the number of activity feed items. Note the default value is 10, and there is a upper cap of 100
  • occurred_since_date string: Restricts the activity feed to only those items that occurred after a supplied date (example format: 2009/12/18 21:00:00 UTC)
  • PROJECT_ID required string: The ID of the project to retrieve the activity for

Output

Output schema unknown

projects.PROJECT_ID.get

Retrieves information about a project.

pivotaltracker.projects.PROJECT_ID.get({
  "PROJECT_ID": ""
}, context)

Input

• input object
  • PROJECT_ID required string: The ID of the project to retrieve

Output

Output schema unknown

projects.get

Retrieves all of the user's projects.

pivotaltracker.projects.get(null, context)

Input

This action has no parameters

Output

Output schema unknown

projects.post

Adds a new project.

pivotaltracker.projects.post(null, context)

Input

This action has no parameters

Output

Output schema unknown

projects.PROJECT_ID.memberships.get

Retrieves all memberships for a project.

pivotaltracker.projects.PROJECT_ID.memberships.get({
  "PROJECT_ID": ""
}, context)

Input

• input object
  • PROJECT_ID required string: The ID of the project

Output

Output schema unknown

projects.PROJECT_ID.memberships.post

Adds a new membership to a project.

pivotaltracker.projects.PROJECT_ID.memberships.post({
  "PROJECT_ID": ""
}, context)

Input

• input object
  • PROJECT_ID required string: The ID of the project

Output

Output schema unknown

projects.PROJECT_ID.memberships.MEMBERSHIP_ID.get

Retrieves information about a single membership.

pivotaltracker.projects.PROJECT_ID.memberships.MEMBERSHIP_ID.get({
  "PROJECT_ID": "",
  "MEMBERSHIP_ID": ""
}, context)

Input

• input object
  • PROJECT_ID required string: The ID of the project
  • MEMBERSHIP_ID required string: The ID of the membership

Output

Output schema unknown

projects.PROJECT_ID.memberships.MEMBERSHIP_ID.delete

Removes a membership from a project

pivotaltracker.projects.PROJECT_ID.memberships.MEMBERSHIP_ID.delete({
  "PROJECT_ID": "",
  "MEMBERSHIP_ID": ""
}, context)

Input

• input object
  • PROJECT_ID required string: The ID of the project
  • MEMBERSHIP_ID required string: The ID of the membership

Output

Output schema unknown

projects.PROJECT_ID.iterations.get

Retrieves all iterations, with stories.

pivotaltracker.projects.PROJECT_ID.iterations.get({
  "PROJECT_ID": ""
}, context)

Input

• input object
  • PROJECT_ID required string: The ID of the project

Output

Output schema unknown

projects.PROJECT_ID.iterations.done.get

Retrieves iterations from the "done" group, with stories.

pivotaltracker.projects.PROJECT_ID.iterations.done.get({
  "PROJECT_ID": ""
}, context)

Input

• input object
  • offset integer: Controls the number of iterations to skip from the beginning of the result.
  • limit integer: Controls the maximum number of iterations returned.
  • PROJECT_ID required string: The ID of the project

Output

Output schema unknown

projects.PROJECT_ID.iterations.current.get

Retrieves iterations from the "current" group, with stories.

pivotaltracker.projects.PROJECT_ID.iterations.current.get({
  "PROJECT_ID": ""
}, context)

Input

• input object
  • PROJECT_ID required string: The ID of the project

Output

Output schema unknown

projects.PROJECT_ID.iterations.backlog.get

Retrieves iterations from the "backlog" group, with stories.

pivotaltracker.projects.PROJECT_ID.iterations.backlog.get({
  "PROJECT_ID": ""
}, context)

Input

• input object
  • offset integer: Controls the number of iterations to skip from the beginning of the result.
  • limit integer: Controls the maximum number of iterations returned.
  • PROJECT_ID required string: The ID of the project

Output

Output schema unknown

projects.PROJECT_ID.iterations.current_backlog.get

Retrieves iterations from the "current" and "backlog" groups, with stories.

pivotaltracker.projects.PROJECT_ID.iterations.current_backlog.get({
  "PROJECT_ID": ""
}, context)

Input

• input object
  • offset integer: Controls the number of iterations to skip from the beginning of the result.
  • limit integer: Controls the maximum number of iterations returned.
  • PROJECT_ID required string: The ID of the project

Output

Output schema unknown

projects.PROJECT_ID.stories.STORY_ID.get

Retrieves information about a single story.

pivotaltracker.projects.PROJECT_ID.stories.STORY_ID.get({
  "PROJECT_ID": "",
  "STORY_ID": ""
}, context)

Input

• input object
  • PROJECT_ID required string: The ID of the project
  • STORY_ID required string: The ID of the story

Output

Output schema unknown

projects.PROJECT_ID.stories.STORY_ID.put

Updates a story

pivotaltracker.projects.PROJECT_ID.stories.STORY_ID.put({
  "PROJECT_ID": "",
  "STORY_ID": ""
}, context)

Input

• input object
  • PROJECT_ID required string: The ID of the project
  • STORY_ID required string: The ID of the story

Output

Output schema unknown

projects.PROJECT_ID.stories.STORY_ID.delete

Deletes a story

pivotaltracker.projects.PROJECT_ID.stories.STORY_ID.delete({
  "PROJECT_ID": "",
  "STORY_ID": ""
}, context)

Input

• input object
  • PROJECT_ID required string: The ID of the project
  • STORY_ID required string: The ID of the story

Output

Output schema unknown

projects.PROJECT_ID.stories.get

Retrieves all stories for a project, or those matching filter(s)

pivotaltracker.projects.PROJECT_ID.stories.get({
  "PROJECT_ID": ""
}, context)

Input

• input object
  • filter string: A filter for the returned stories to match. See the API documentation for more details.
  • offset integer: Controls the number of stories to skip from the beginning of the result.
  • limit integer: Controls the maximum number of stories returned.
  • PROJECT_ID required string: The ID of the project

Output

Output schema unknown

projects.PROJECT_ID.stories.post

Adds a new story

pivotaltracker.projects.PROJECT_ID.stories.post({
  "PROJECT_ID": ""
}, context)

Input

• input object
  • PROJECT_ID required string: The ID of the project

Output

Output schema unknown

projects.PROJECT_ID.stories.STORY_ID.notes.put

Adds a note (comment)

pivotaltracker.projects.PROJECT_ID.stories.STORY_ID.notes.put({
  "PROJECT_ID": "",
  "STORY_ID": ""
}, context)

Input

• input object
  • PROJECT_ID required string: The ID of the project
  • STORY_ID required string: The ID of the story

Output

Output schema unknown

projects.PROJECT_ID.stories.deliver_all_finished.post

Takes all finished stories and marks them as delivered. This could be used to automate a demo deploy process. The updated stories are returned as the result.

pivotaltracker.projects.PROJECT_ID.stories.deliver_all_finished.post({
  "PROJECT_ID": ""
}, context)

Input

• input object
  • PROJECT_ID required string: The ID of the project

Output

Output schema unknown

projects.PROJECT_ID.stories.STORY_ID.moves.post

Moves a story before or after another story. The moved story is returned in the response.

pivotaltracker.projects.PROJECT_ID.stories.STORY_ID.moves.post({
  "PROJECT_ID": "",
  "STORY_ID": ""
}, context)

Input

• input object
  • PROJECT_ID required string: The ID of the project
  • STORY_ID required string: The ID of the story

Output

Output schema unknown

projects.PROJECT_ID.stories.STORY_ID.tasks.TASK_ID.get

Returns information about a single task

pivotaltracker.projects.PROJECT_ID.stories.STORY_ID.tasks.TASK_ID.get({
  "PROJECT_ID": "",
  "STORY_ID": "",
  "TASK_ID": ""
}, context)

Input

• input object
  • PROJECT_ID required string: The ID of the project
  • STORY_ID required string: The ID of the story
  • TASK_ID required string: The ID of the task

Output

Output schema unknown

projects.PROJECT_ID.stories.STORY_ID.tasks.TASK_ID.put

Updates a task

pivotaltracker.projects.PROJECT_ID.stories.STORY_ID.tasks.TASK_ID.put({
  "PROJECT_ID": "",
  "STORY_ID": "",
  "TASK_ID": ""
}, context)

Input

• input object
  • PROJECT_ID required string: The ID of the project
  • STORY_ID required string: The ID of the story
  • TASK_ID required string: The ID of the task

Output

Output schema unknown

projects.PROJECT_ID.stories.STORY_ID.tasks.TASK_ID.delete

Deletes a task

pivotaltracker.projects.PROJECT_ID.stories.STORY_ID.tasks.TASK_ID.delete({
  "PROJECT_ID": "",
  "STORY_ID": "",
  "TASK_ID": ""
}, context)

Input

• input object
  • PROJECT_ID required string: The ID of the project
  • STORY_ID required string: The ID of the story
  • TASK_ID required string: The ID of the task

Output

Output schema unknown

projects.PROJECT_ID.stories.STORY_ID.tasks.get

Returns all tasks for a story

pivotaltracker.projects.PROJECT_ID.stories.STORY_ID.tasks.get({
  "PROJECT_ID": "",
  "STORY_ID": ""
}, context)

Input

• input object
  • PROJECT_ID required string: The ID of the project
  • STORY_ID required string: The ID of the story

Output

Output schema unknown

projects.PROJECT_ID.stories.STORY_ID.tasks.post

Adds a task to a story

pivotaltracker.projects.PROJECT_ID.stories.STORY_ID.tasks.post({
  "PROJECT_ID": "",
  "STORY_ID": ""
}, context)

Input

• input object
  • PROJECT_ID required string: The ID of the project
  • STORY_ID required string: The ID of the story

Output

Output schema unknown

projects.PROJECT_ID.stories.STORY_ID.attachments.post

Uploads an attachment to a story.

pivotaltracker.projects.PROJECT_ID.stories.STORY_ID.attachments.post({
  "PROJECT_ID": "",
  "STORY_ID": ""
}, context)

Input

• input object
  • PROJECT_ID required string: The ID of the project
  • STORY_ID required string: The ID of the story

Output

Output schema unknown

source_commits.post

Allows integration with post-commit hooks of Source Control Management (SCM) systems such as Subversion, Git, etc.

pivotaltracker.source_commits.post(null, context)

Input

This action has no parameters

Output

Output schema unknown

Definitions

This integration has no definitions