Atlassian · Example Payload

Atlassian Atlassiancreatenotificationscheme Example

CodeCollaborationPlatformProductivitySoftware Development

Atlassian Atlassiancreatenotificationscheme 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": "atlassianCreatenotificationscheme",
  "method": "POST",
  "path": "/rest/api/3/notificationscheme",
  "summary": "Atlassian Create Notification Scheme",
  "requestExamples": [
    {
      "contentType": "application/json",
      "example": {
        "description": "My new scheme description",
        "name": "My new notification scheme",
        "notificationSchemeEvents": [
          {
            "event": {
              "id": "1"
            },
            "notifications": [
              {
                "notificationType": "Group",
                "parameter": "jira-administrators"
              }
            ]
          }
        ]
      }
    }
  ],
  "responseExamples": [
    {
      "status": "201",
      "contentType": "application/json",
      "example": "{\"id\":\"10001\"}"
    },
    {
      "status": "400",
      "contentType": "application/json",
      "example": "{\"errorMessages\":[\"The length of the description must not exceed 4000 characters.\"],\"errors\":{}}"
    },
    {
      "status": "403",
      "contentType": "application/json",
      "example": "{\"errorMessages\":[\"You are not authorized to perform this action. Administrator privileges are required.\"],\"errors\":{}}"
    }
  ]
}