Atlassian · Example Payload

Atlassian Atlassianupdatecustomfield Example

CodeCollaborationPlatformProductivitySoftware Development

Atlassian Atlassianupdatecustomfield 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": "atlassianUpdatecustomfield",
  "method": "PUT",
  "path": "/rest/api/3/field/{fieldId}",
  "summary": "Atlassian Update Custom Field",
  "requestExamples": [
    {
      "contentType": "application/json",
      "example": {
        "description": "Select the manager and the corresponding employee.",
        "name": "Managers and employees list",
        "searcherKey": "com.atlassian.jira.plugin.system.customfieldtypes:cascadingselectsearcher"
      }
    }
  ],
  "responseExamples": [
    {
      "status": "400",
      "contentType": "application/json",
      "example": "{\"errorMessages\":[\"searcherKey is invalid for the field type.\"],\"errors\":{}}"
    },
    {
      "status": "403",
      "contentType": "application/json",
      "example": "{\"errorMessages\":[\"Only Jira administrators can edit custom fields.\"],\"errors\":{}}"
    },
    {
      "status": "404",
      "contentType": "application/json",
      "example": "{\"errorMessages\":[\"The custom field was not found.\"],\"errors\":{}}"
    }
  ]
}