Atlassian · Example Payload

Atlassian Atlassiancreatecustomfieldoption Example

CodeCollaborationPlatformProductivitySoftware Development

Atlassian Atlassiancreatecustomfieldoption 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": "atlassianCreatecustomfieldoption",
  "method": "POST",
  "path": "/rest/api/3/field/{fieldId}/context/{contextId}/option",
  "summary": "Atlassian Create Custom Field Options Context",
  "requestExamples": [
    {
      "contentType": "application/json",
      "example": {
        "options": [
          {
            "disabled": false,
            "value": "Scranton"
          },
          {
            "disabled": true,
            "optionId": "10000",
            "value": "Manhattan"
          },
          {
            "disabled": false,
            "value": "The Electric City"
          }
        ]
      }
    }
  ],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": "{\"options\":[{\"disabled\":false,\"id\":\"10001\",\"value\":\"Scranton\"},{\"disabled\":true,\"id\":\"10002\",\"optionId\":\"10000\",\"value\":\"Manhattan\"},{\"disabled\":false,\"id\":\"10003\",\"value\":\"The Electric City\"}]}"
    },
    {
      "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\":{}}"
    }
  ]
}