Atlassian · Example Payload

Atlassian Atlassiancreateuimodification Example

CodeCollaborationPlatformProductivitySoftware Development

Atlassian Atlassiancreateuimodification 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

{
  "operationId": "atlassianCreateuimodification",
  "method": "POST",
  "path": "/rest/api/3/uiModifications",
  "summary": "Atlassian Create Ui Modification",
  "requestExamples": [
    {
      "contentType": "application/json",
      "example": {
        "contexts": [
          {
            "issueTypeId": "10000",
            "projectId": "10000",
            "viewType": "GIC"
          },
          {
            "issueTypeId": "10001",
            "projectId": "10000",
            "viewType": "IssueView"
          },
          {
            "issueTypeId": "10002",
            "projectId": "10000",
            "viewType": null
          }
        ],
        "data": "{field: 'Story Points', config: {hidden: false}}",
        "description": "Reveals Story Points field when any Sprint is selected.",
        "name": "Reveal Story Points"
      }
    }
  ],
  "responseExamples": [
    {
      "status": "201",
      "contentType": "application/json",
      "example": "{\"id\":\"d7dbda8a-6239-4b63-8e13-a5ef975c8e61\",\"self\":\"https://api.atlassian.com/ex/jira/{cloudid}/rest/api/2/uiModifications/d7dbda8a-6239-4b63-8e13-a5ef975c8e61\"}"
    },
    {
      "status": "404",
      "contentType": "application/json",
      "example": "{\"details\":{\"issueTypesNotFound\":{\"10001\":[\"10000\",\"10001\"]},\"projectNotFound\":[\"10000\"]},\"errorMessages\":[\"Project with ID '10000' was not found.\",\"Project with ID '10001'. The following issue types were not found: [10000, 10001]\"],\"errors\":{}}"
    }
  ]
}