Resource: Project Templates ( /api/projecttemplates )
Project templates that can be used when creating a new project to pre-populate the project with data.
Root Relation: ProjectTemplates
This resource supports the following methods: GET
Methods
GET
Retrieves all (or a subset) of project templates that are visible to the user.
This method supports the OData parameters $filter, $top, $take, $orderby and $inlinecount. See OData Topic for more details.
Status Codes
These are the expected status codes returned by the service. In addition, some other status codes may be returned if either an internal error occurs or there is an authentication issue (such as an expired OAuth token).
| Status | Description |
|---|---|
| 200 - OK | Returned if the request was completed successfully. |
An example of retrieving all project templates.
Request Headers
| Key | Value | Description |
|---|---|---|
| Accept | application/json |
Response Headers
| Key | Value | Description |
|---|---|---|
| Content-Type | application/json; charset=utf-8 |
Response Body
| Code Block | ||
|---|---|---|
| ||
[
{
"Id": "eb06e5d8-f774-4b0f-a95c-a911c13527a9",
"Title": "Agile Template",
"Expands": [],
"Self": "http://localhost/api/projecttemplate/eb06e5d8-f774-4b0f-a95c-a911c13527a9"
},
{
"Id": "00000000-0000-0000-0000-000000000000",
"Title": "Empty Project",
"Expands": [],
"Self": "http://localhost/api/projecttemplate/00000000-0000-0000-0000-000000000000"
}
]
|
Status Code
200 - OK
Example of fetching a set of project templates by name, by using the ODATA $filter query parameter.
Request Headers
| Key | Value | Description |
|---|---|---|
| Accept | application/json |
Request Parameters
| Key | Value | Description |
|---|---|---|
| $filter | Title eq 'Agile Template' | The ODATA $filter parameter, this query parameter should be url encoded i.e. $filter=Title%20eq%20'Agile Template'. |
Response Headers
| Key | Value | Description |
|---|---|---|
| Content-Type | application/json; charset=utf-8 |
Response Body
| Code Block | ||
|---|---|---|
| ||
[
{
"Id": "eb06e5d8-f774-4b0f-a95c-a911c13527a9",
"Title": "Agile Template",
"Expands": [],
"Self": "http://localhost/api/projecttemplate/eb06e5d8-f774-4b0f-a95c-a911c13527a9"
}
]
|
Status Code
200 - OK