Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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).

...

Example - Search for picklist values

Search for picklist values by partial name

Request Headers

KeyValueDescription
AcceptContent-Typeapplication/json; charset=utf-8

Request Parameters

KeyValueDescription
{organisationId}bc692c60-99b2-4df3-8cf8-74f4ac770b16Unique ID of the organisation related to the picklist values.
{type}PriorityThe picklist type e.g. RequirementType,RequirementStatus,Priority,RequirementDifficulty etc.
queryHThe partial name to search for

Response Headers

KeyValueDescription
Content-Typeapplication/json; charset=utf-8

Response Body

Code Block
languagenone
{
  "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

...

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

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).

...

Example - Search for picklist values

Search for picklist values by partial name

Request Headers

KeyValueDescription
AcceptContent-Typeapplication/jsonx-www-form-urlencoded

Request Parameters

KeyValueDescription
{organisationId}bc692c60-99b2-4df3-8cf8-74f4ac770b16Unique ID of the organisation related to the picklist values.
{type}PriorityThe picklist type e.g. RequirementType,RequirementStatus,Priority,RequirementDifficulty etc.
queryHThe partial name to search for

Response Headers

KeyValueDescription
Content-Typeapplication/json; charset=utf-8

Response Body

Code Block
languagenone
{
  "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"
}

Status Code

200 - OK

...