...
Example - Get Project (with expansions)
Example of fetching a single project (with Priority and Status picklists expanded).
Request Headers
Key | Value | Description |
---|---|---|
Accept | application/json |
Request Parameters
Key | Value | Description |
---|---|---|
{id} | EB06E5D8-F774-4B0F-A95C-A911C13527A9 | Unique GUID identifier of the project. |
$expand | Priorities,Statuses | Expand properties to eager fetch. |
Response Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json; charset=utf-8 |
Response Body
Code Block | ||
---|---|---|
| ||
{ "Id": "eb06e5d8-f774-4b0f-a95c-a911c13527a9", "Name": "Test Project", "OrganisationId": "41930a0d-0d44-4a82-a9de-e2c25780130b", "OrganisationName": "Acme Inc", "ProjectCategoryId": null, "ProjectCategoryName": null, "Description": null, "EstimatedEndDate": null, "ManagerId": null, "ManagerUserName": null, "Slug": "test-project", "AutoNumberRequirements": false, "AutoNumberScripts": false, "Independent": false, "RequirementNumberReadOnly": false, "ScriptNumberReadOnly": false, "OrderNumber": 0, "StartDate": null, "Expands": [ "RequirementTypes", "RequirementStatuses", "RequirementDifficulties", "IncidentTypes", "TestTypes", "IncidentResolutions", "IncidentStatuses", "Versions", "Components", "ExecutionPackages", "ScriptPackages", "RequirementPackages", "TimeTrackingConfiguration" ], "Priorities": [ { "Id": "6b1e46f4-8b59-4dc3-8ed1-0b3b89612e34", "Text": "Low", "SortOrder": 1, "Self": "http://localhost/api/project/eb06e5d8-f774-4b0f-a95c-a911c13527a9/priority/6b1e46f4-8b59-4dc3-8ed1-0b3b89612e34" }, { "Id": "5d37d6a1-6b1d-4007-8fcf-2c5296af3740", "Text": "High", "SortOrder": 2, "Self": "http://localhost/api/project/eb06e5d8-f774-4b0f-a95c-a911c13527a9/priority/5d37d6a1-6b1d-4007-8fcf-2c5296af3740" } ], "Statuses": [ { "Id": "753387d7-0a67-45bd-8b96-a58791c283bb", "Text": "Draft", "SortOrder": 1, "Self": "http://localhost/api/project/eb06e5d8-f774-4b0f-a95c-a911c13527a9/status/753387d7-0a67-45bd-8b96-a58791c283bb" }, { "Id": "023b39dc-31a3-4bb6-bf01-69da23de5d3f", "Text": "Final", "SortOrder": 2, "Self": "http://localhost/api/project/eb06e5d8-f774-4b0f-a95c-a911c13527a9/status/023b39dc-31a3-4bb6-bf01-69da23de5d3f" } ], "Self": "http://localhost/api/project/eb06e5d8-f774-4b0f-a95c-a911c13527a9", "Links": [ { "Title": "Project Tickets Search", "Href": "http://localhost/api/project/eb06e5d8-f774-4b0f-a95c-a911c13527a9/tickets", "Rel": "Tickets" }, { "Title": "Project Assignees Search", "Href": "http://localhost/api/project/eb06e5d8-f774-4b0f-a95c-a911c13527a9/assignees", "Rel": "Assignees" } ] } |
Status Code
200 - OK
...