Atlassian · Example Payload

Atlassian Atlassiangetnotificationschemes Example

CodeCollaborationPlatformProductivitySoftware Development

Atlassian Atlassiangetnotificationschemes 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": "atlassianGetnotificationschemes",
  "method": "GET",
  "path": "/rest/api/3/notificationscheme",
  "summary": "Atlassian Get Notification Schemes Paginated",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": "{\"isLast\":false,\"maxResults\":6,\"startAt\":1,\"total\":5,\"values\":[{\"description\":\"description\",\"expand\":\"notificationSchemeEvents,user,group,projectRole,field,all\",\"id\":10100,\"name\":\"notification scheme name\",\"notificationSchemeEvents\":[{\"event\":{\"description\":\"Event published when an issue is created\",\"id\":1,\"name\":\"Issue created\"},\"notifications\":[{\"expand\":\"group\",\"group\":{\"groupId\":\"276f955c-63d7-42c8-9520-92d01dca0625\",\"name\":\"jira-administrators\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625\"},\"id\":1,\"notificationType\":\"Group\",\"parameter\":\"jira-administrators\",\"recipient\":\"276f955c-63d7-42c8-9520-92d01dca0625\"},{\"id\":2,\"notificationType\":\"CurrentAssignee\"},{\"expand\":\"projectRole\",\"id\":3,\"notificationType\":\"ProjectRole\",\"parameter\":\"10360\",\"projectRole\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360\",\"name\":\"Developers\",\"id\":10360,\"description\":\"A project role that represents developers in a project\",\"actors\":[{\"actorGroup\":{\"name\":\"jira-developers\",\"displayName\":\"jira-developers\",\"groupId\":\"952d12c3-5b5b-4d04-bb32-44d383afc4b2\"},\"displayName\":\"jira-developers\",\"id\":10240,\"name\":\"jira-developers\",\"type\":\"atlassian-group-role-actor\"},{\"actorUser\":{\"accountId\":\"5b10a2844c20165700ede21g\"},\"displayName\":\"Mia Krystof\",\"id\":10241,\"type\":\"atlassian-user-role-actor\"}],\"scope\":{\"project\":{\"id\":\"10000\",\"key\":\"KEY\",\"name\":\"Next Gen Project\"},\"type\":\"PROJECT\"}},\"recipient\":\"10360\"},{\"emailAddress\":\"rest-developer@atlassian.com\",\"id\":4,\"notificationType\":\"EmailAddress\",\"parameter\":\"rest-developer@atlassian.com\",\"recipient\":\"rest-developer@atlassian.com\"},{\"expand\":\"user\",\"id\":5,\"notificationType\":\"User\",\"parameter\":\"5b10a2844c20165700ede21g\",\"recipient\":\"5b10a2844c20165700ede21g\",\"user\":{\"accountId\":\"5b10a2844c20165700ede21g\",\"active\":false,\"displayName\":\"Mia Krystof\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\"}},{\"expand\":\"field\",\"field\":{\"clauseNames\":[\"cf[10101]\",\"New custom field\"],\"custom\":true,\"id\":\"customfield_10101\",\"key\":\"customfield_10101\",\"name\":\"New custom field\",\"navigable\":true,\"orderable\":true,\"schema\":{\"custom\":\"com.atlassian.jira.plugin.system.customfieldtypes:project\",\"customId\":10101,\"type\":\"project\"},\"searchable\":true,\"untranslatedName\":\"New custom field\"},\"id\":6,\"notificationType\":\"GroupCustomField\",\"parameter\":\"customfield_10101\",\"recipient\":\"customfield_10101\"}]},{\"event\":{\"description\":\"Custom event that is published together with an issue created event\",\"id\":20,\"name\":\"Custom event\",\"templateEvent\":{\"description\":\"Event published when an issue is created\",\"id\":1,\"name\":\"Issue created\"}},\"notifications\":[{\"expand\":\"group\",\"group\":{\"groupId\":\"276f955c-63d7-42c8-9520-92d01dca0625\",\"name\":\"jira-administrators\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625\"},\"id\":1,\"notificationType\":\"Group\",\"parameter\":\"jira-administrators\",\"recipient\":\"276f955c-63d7-42c8-9520-92d01dca0625\"},{\"id\":2,\"notificationType\":\"CurrentAssignee\"},{\"expand\":\"projectRole\",\"id\":3,\"notificationType\":\"ProjectRole\",\"parameter\":\"10360\",\"projectRole\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360\",\"name\":\"Developers\",\"id\":10360,\"description\":\"A project role that represents developers in a project\",\"actors\":[{\"actorGroup\":{\"name\":\"jira-developers\",\"displayName\":\"jira-developers\",\"groupId\":\"952d12c3-5b5b-4d04-bb32-44d383afc4b2\"},\"displayName\":\"jira-developers\",\"id\":10240,\"name\":\"jira-developers\",\"type\":\"atlassian-group-role-actor\"},{\"actorUser\":{\"accountId\":\"5b10a2844c20165700ede21g\"},\"displayName\":\"Mia Krystof\",\"id\":10241,\"type\":\"atlassian-user-role-actor\"}],\"scope\":{\"project\":{\"id\":\"10000\",\"key\":\"KEY\",\"name\":\"Next Gen Project\"},\"type\":\"PROJECT\"}},\"recipient\":\"10360\"},{\"emailAddress\":\"rest-developer@atlassian.com\",\"id\":4,\"notificationType\":\"EmailAddress\",\"parameter\":\"rest-developer@atlassian.com\",\"recipient\":\"rest-developer@atlassian.com\"},{\"expand\":\"user\",\"id\":5,\"notificationType\":\"User\",\"parameter\":\"5b10a2844c20165700ede21g\",\"recipient\":\"5b10a2844c20165700ede21g\",\"user\":{\"accountId\":\"5b10a2844c20165700ede21g\",\"active\":false,\"displayName\":\"Mia Krystof\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\"}},{\"expand\":\"field\",\"field\":{\"clauseNames\":[\"cf[10101]\",\"New custom field\"],\"custom\":true,\"id\":\"customfield_10101\",\"key\":\"customfield_10101\",\"name\":\"New custom field\",\"navigable\":true,\"orderable\":true,\"schema\":{\"custom\":\"com.atlassian.jira.plugin.system.customfieldtypes:project\",\"customId\":10101,\"type\":\"project\"},\"searchable\":true,\"untranslatedName\":\"New custom field\"},\"id\":6,\"notificationType\":\"GroupCustomField\",\"parameter\":\"customfield_10101\",\"recipient\":\"customfield_10101\"}]}],\"projects\":[10001,10002],\"self\":\"https://your-domain.atlassian.net/rest/api/3/notificationscheme\"}]}"
    },
    {
      "status": "400",
      "contentType": "application/json",
      "example": "{\"errorMessages\":[\"%20. is not a valid value. id must be zero or a positive integer.\"],\"errors\":{}}"
    }
  ]
}