Atlassian · Example Payload

Atlassian Atlassiangetfieldspaginated Example

CodeCollaborationPlatformProductivitySoftware Development

Atlassian Atlassiangetfieldspaginated 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": "atlassianGetfieldspaginated",
  "method": "GET",
  "path": "/rest/api/3/field/search",
  "summary": "Atlassian Get Fields Paginated",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": "{\"isLast\":false,\"maxResults\":50,\"startAt\":0,\"total\":2,\"values\":[{\"id\":\"customfield_10000\",\"name\":\"Approvers\",\"schema\":{\"custom\":\"com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker\",\"customId\":10000,\"items\":\"user\",\"type\":\"array\"},\"description\":\"Contains users needed for approval. This custom field was created by Jira Service Desk.\",\"key\":\"customfield_10000\",\"isLocked\":true,\"searcherKey\":\"com.atlassian.jira.plugin.system.customfieldtypes:userpickergroupsearcher\",\"screensCount\":2,\"contextsCount\":2,\"lastUsed\":{\"type\":\"TRACKED\",\"value\":\"2021-01-28T07:37:40.000+0000\"}},{\"id\":\"customfield_10001\",\"name\":\"Change reason\",\"schema\":{\"custom\":\"com.atlassian.jira.plugin.system.customfieldtypes:select\",\"customId\":10001,\"type\":\"option\"},\"description\":\"Choose the reason for the change request\",\"key\":\"customfield_10001\",\"isLocked\":false,\"searcherKey\":\"com.atlassian.jira.plugin.system.customfieldtypes:multiselectsearcher\",\"screensCount\":2,\"contextsCount\":2,\"projectsCount\":2,\"lastUsed\":{\"type\":\"NOT_TRACKED\"}}]}"
    },
    {
      "status": "400",
      "contentType": "application/json",
      "example": "{\"errorMessages\":[\"Only custom fields can be queried.\"],\"errors\":{}}"
    },
    {
      "status": "403",
      "contentType": "application/json",
      "example": "{\"errorMessages\":[\"Only Jira administrators can access fields.\"],\"errors\":{}}"
    }
  ]
}