Projects

Manage projects in TeamPulse.

GET /projects/{id} - Get project by ID

GET /projects - Get all projects for which the user has access to.

Project Model

The object representing a project has the following properties:

id: integer - ID of the project.

name: string - Name of the project.

template: string - Template name of the project.

description: string - Description of the project.

startDate: DateTime - Start date of the project.

endDate: DateTime - End date of the project.

defaultIterationLength: integer - Default iteration length of the project.

createdBy: string - The name of the user who created the project

createdAt: DateTime - The date when the project is created

lastModifiedBy: string - The name of the user who last modified the project

lastModifiedAt: DateTime - The date when the project is last modified

Resource Url

To make API requests use the URL [teampulse]/api/v1 where [teampulse] is the URL to the TeamPulse instance which you want to manage via the API.

Example:

[teampulse]/api/v1/projects

Get a project

GET /projects/{id}

Response

HTTP/1.1 200

{
  "id": 2,
  "name": "Sample Project",
  "template": "TeamPulse",
  "description": "Description for Sample Project",
  "startDate": "2013-06-12T00:00:00",
  "endDate": "2013-10-15T00:00:00",
  "defaultIterationLength": 14,
  "createdBy": "SuperUser",
  "createdAt": "2013-10-04T11:08:24.673",
  "lastModifiedBy": "SuperUser",
  "lastModifiedAt": "2013-10-04T11:08:24.673"
}

Get projects

GET /projects : Get all projects which the user has access to.

OData $filter and $orderby options can be supplied to filter and order the results. $top and $skip to get top N items and skip the top M. Read more how to use the OData options

Response

HTTP/1.1 200

{
  "totalResults": 2,
  "top": 2,
  "results": [
    {
        "id": 1,
        "name": "Sample Project 1",
        "template": "TeamPulse",
        "description": "Description Project 1",
        "startDate": "2013-06-08T00:00:00",
        "endDate": "2014-07-05T00:00:00",
        "defaultIterationLength": 14,
        "createdBy": "SuperUser",
        "createdAt": "2013-10-04T11:08:24.673",
        "lastModifiedBy": "SuperUser",
        "lastModifiedAt": "2013-10-04T11:08:24.673"
    },
    {
        "id": 2,
        "name": "Sample Project 2",
        "template": "TeamPulse",
        "description": "Description Project 2",
        "startDate": "2013-06-12T00:00:00",
        "endDate": "2013-10-15T00:00:00",
        "defaultIterationLength": 14,
        "createdBy": "SuperUser",
        "createdAt": "2013-10-04T11:08:24.673",
        "lastModifiedBy": "SuperUser",
        "lastModifiedAt": "2013-10-04T11:08:24.673"
    }
  ]
}