Resource: Organisation Picklist Search ( /api/organisation/{organisationId}/picklistsearch/{type} )

Allows the searching of picklist values for an organisation by partial name match.

This resource supports the following methods: GET, POST

Methods

GET

Searches for picklist values by partial name match

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 organisation does not exist.

Example - Search for picklist values

Search for picklist values by partial name

Request Headers

Key	Value	Description
Content-Type	application/json; charset=utf-8

Request Parameters

Key	Value	Description
{organisationId}	bc692c60-99b2-4df3-8cf8-74f4ac770b16	Unique ID of the organisation related to the picklist values.
{type}	Priority	The picklist type e.g. RequirementType,RequirementStatus,Priority,RequirementDifficulty etc.
query	H	The partial name to search for

Response Headers

Key	Value	Description
Content-Type	application/json; charset=utf-8

Response Body

{
  "Items": [
    {
      "Id": "2fe983c7-bc0d-430f-83f2-9a97863e4891",
      "Text": "High",
      "SortOrder": 0,
      "Self": "http://localhost/api/organisation/bc692c60-99b2-4df3-8cf8-74f4ac770b16/priority/2fe983c7-bc0d-430f-83f2-9a97863e4891"
    }
  ],
  "Self": "http://localhost/api/api/organisation/BC692C60-99B2-4DF3-8CF8-74F4AC770B16/picklistsearch/Priority?query=H"
}

Status Code

200 - OK

POST

Searches for picklist values by partial name match (using POST to allow large existing value queries)