Resource: Project Picklist ( /api/project/{projectId}/picklist/{type} )
Used to retrieve the picklist values associated with a project
This resource supports the following methods: GET
Methods
GET
Retrieve picklist values specific to a project.
This method supports the OData parameters $filter, $top, $take, $orderby and $inlinecount. See OData Topic for more details.
Required Permissions
- TestManagement/ManageExecutions/View
- TestManagement/ManageScripts/View
- TestManagement/ManageIncidents/View
- TestManagement/ManageRequirements/View
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 picklist values were retrieved successfully. |
| 403 - Forbidden | Returned if the user does not have permission to view picklist values for this project. |
| 404 - NotFound | Returned if the project does not exist. |
Example - Retrieve all picklist values
Retrieve all picklist value for the picklist 'Priority'.
Request Headers
| Key | Value | Description |
|---|---|---|
| Accept | application/json |
Request Parameters
| Key | Value | Description |
|---|---|---|
| {projectId} | bc692c60-99b2-4df3-8cf8-74f4ac770b16 | Unique ID of the project related to the picklist values. |
| {type} | Priority | The picklist type e.g. Priority, RequirementType, RequirementStatus, RequirementDifficulty, IncidentResolution etc. |
Response Headers
| Key | Value | Description |
|---|---|---|
| Content-Type | application/json; charset=utf-8 |
Response Body
| Code Block | ||
|---|---|---|
| ||
{
"Items": [
{
"Id": "2fe983c7-bc0d-430f-83f2-9a97863e4891",
"Text": "High",
"SortOrder": 0,
"Self": "http://localhost/api/project/bc692c60-99b2-4df3-8cf8-74f4ac770b16/priority/2fe983c7-bc0d-430f-83f2-9a97863e4891"
},
{
"Id": "fb82918b-cb0e-4c38-b994-bc35f469d020",
"Text": "Medium",
"SortOrder": 1,
"Self": "http://localhost/api/project/bc692c60-99b2-4df3-8cf8-74f4ac770b16/priority/fb82918b-cb0e-4c38-b994-bc35f469d020"
},
{
"Id": "b6a3cb4d-638b-4803-9cf5-bc9830e29835",
"Text": "Low",
"SortOrder": 2,
"Self": "http://localhost/api/project/bc692c60-99b2-4df3-8cf8-74f4ac770b16/priority/b6a3cb4d-638b-4803-9cf5-bc9830e29835"
}
],
"Self": "http://localhost/api/api/project/BC692C60-99B2-4DF3-8CF8-74F4AC770B16/picklistsearch/Priority"
}
|
Status Code
200 - OK