Atlassian · Example Payload

Atlassian Atlassiansetbanner Example

CodeCollaborationPlatformProductivitySoftware Development

Atlassian Atlassiansetbanner 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": "atlassianSetbanner",
  "method": "PUT",
  "path": "/rest/api/3/announcementBanner",
  "summary": "Atlassian Update Announcement Banner Configuration",
  "requestExamples": [
    {
      "contentType": "application/json",
      "example": {
        "isDismissible": false,
        "isEnabled": true,
        "message": "This is a public, enabled, non-dismissible banner, set using the API",
        "visibility": "public"
      }
    }
  ],
  "responseExamples": [
    {
      "status": "400",
      "contentType": "application/json",
      "example": "\"Banner message cannot be null.\""
    },
    {
      "status": "403",
      "contentType": "application/json",
      "example": "\"Only admins can update banner configuration.\""
    }
  ]
}