Atlassian · Example Payload

Atlassian Atlassiangetoptionsforcontext Example

CodeCollaborationPlatformProductivitySoftware Development

Atlassian Atlassiangetoptionsforcontext Example is an example object payload from Atlassian, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

Raw ↑ 
{
  "operationId": "atlassianGetoptionsforcontext",
  "method": "GET",
  "path": "/rest/api/3/field/{fieldId}/context/{contextId}/option",
  "summary": "Atlassian Get Custom Field Options Context",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": "{\"isLast\":true,\"maxResults\":100,\"startAt\":0,\"total\":4,\"values\":[{\"id\":\"10001\",\"value\":\"New York\"},{\"id\":\"10002\",\"value\":\"Boston\",\"disabled\":true},{\"id\":\"10004\",\"value\":\"Denver\"},{\"id\":\"10003\",\"value\":\"Brooklyn\",\"optionId\":\"10001\"}]}"
    },
    {
      "status": "400",
      "contentType": "application/json",
      "example": "{\"errorMessages\":[\"The custom field doesn't support options.\"],\"errors\":{}}"
    },
    {
      "status": "403",
      "contentType": "application/json",
      "example": "{\"errorMessages\":[\"Only Jira administrators can manage custom field options.\"],\"errors\":{}}"
    },
    {
      "status": "404",
      "contentType": "application/json",
      "example": "{\"errorMessages\":[\"The custom field was not found.\"],\"errors\":{}}"
    }
  ]
}