Teams
Manage teams in TeamPulse.
GET /teams/{id} - Get team by ID
GET /teams - Get all teams for the projects for which the user has access to.
GET /projects/{projectId}/teams - Get teams for a specific project.
POST /teams - Create a team
PUT /teams/{id} - Update a team
DELETE /teams/{id} - Delete a team
Team Model
The object representing a team has the following properties:
id: integer (Read-only)
- ID of the team.
name: string (Required)
- Name of the team.
projectId: integer (Required, Read-only)
- ID of the project to which this team belongs to.
createdBy: string
- The name of the user who created the team
createdAt: DateTime
- The date when the team is created
lastModifiedBy: string
- The name of the user who last modified the team
lastModifiedAt: DateTime
- The date when the team 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/teams
Get a team
GET /teams/{id}
Response
HTTP/1.1 200
{
"id": 1,
"name": "Sample team 1",
"projectId": 1,
"createdBy": "Paul Smith",
"createdAt": "2013-06-20T10:10:00",
"lastModifiedBy": "Paul Smith",
"lastModifiedAt": "2013-06-20T11:45:00"
}
Get teams
GET /teams - Get all teams for the projects for which the user has access to.
GET /projects/{projectId}/teams - Get teams for a specific project.
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": 3,
"top": 3,
"results": [
{
"id": 1,
"name": "Sample team 1",
"projectId": 1,
"createdBy": "Paul Smith",
"createdAt": "2013-06-20T10:10:00",
"lastModifiedBy": "Paul Smith",
"lastModifiedAt": "2013-06-20T11:45:00"
},
{
"id": 2,
"name": "Sample team 2",
"projectId": 1,
"createdBy": "Paul Smith",
"createdAt": "2013-06-20T10:10:00",
"lastModifiedBy": "Paul Smith",
"lastModifiedAt": "2013-06-20T11:45:00"
},
{
"id": 3,
"name": "Sample team 3",
"projectId": 1,
"createdBy": "Paul Smith",
"createdAt": "2013-06-20T10:10:00",
"lastModifiedBy": "Paul Smith",
"lastModifiedAt": "2013-06-20T11:45:00"
}
]
}
Create a team
POST /teams
Request
{
"name": "Sample team 1",
"projectId": 1
}
Response
HTTP/1.1 201
{
"id": 1,
"name": "Sample team 1",
"projectId": 1,
"createdBy": "Paul Smith",
"createdAt": "2013-06-20T10:10:00",
"lastModifiedBy": "Paul Smith",
"lastModifiedAt": "2013-06-20T11:45:00"
}
Update a team
PUT /teams/{id}
The update can be done partially so only the properties that need to be updated can be provided in the request.
Request
{
"name": "Sample team 1"
}
Response
HTTP/1.1 200
{
"id": 1,
"name": "Sample team 1",
"projectId": 1,
"createdBy": "Paul Smith",
"createdAt": "2013-06-20T10:10:00",
"lastModifiedBy": "Paul Smith",
"lastModifiedAt": "2013-06-20T11:45:00"
}
Delete a team
DELETE /teams/{id}
Response
HTTP/1.1 200