Atlassian · Example Payload

Atlassian Atlassianaddgadget Example

CodeCollaborationPlatformProductivitySoftware Development

Atlassian Atlassianaddgadget 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": "atlassianAddgadget",
  "method": "POST",
  "path": "/rest/api/3/dashboard/{dashboardId}/gadget",
  "summary": "Atlassian Add Gadget To Dashboard",
  "requestExamples": [
    {
      "contentType": "application/json",
      "example": {
        "color": "blue",
        "ignoreUriAndModuleKeyValidation": false,
        "moduleKey": "com.atlassian.plugins.atlassian-connect-plugin:com.atlassian.connect.node.sample-addon__sample-dashboard-item",
        "position": {
          "column": 1,
          "row": 0
        },
        "title": "Issue statistics"
      }
    }
  ],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": "{\"id\":10001,\"moduleKey\":\"com.atlassian.plugins.atlassian-connect-plugin:com.atlassian.connect.node.sample-addon__sample-dashboard-item\",\"color\":\"blue\",\"position\":{\"row\":0,\"column\":1},\"title\":\"Issue statistics\"}"
    },
    {
      "status": "400",
      "contentType": "application/json",
      "example": "{\"errorMessages\":[\"Cannot add another gadget. The maximum number of gadgets the dashboard can hold has been reached.\"],\"errors\":{}}"
    },
    {
      "status": "404",
      "contentType": "application/json",
      "example": "{\"errorMessages\":[\"The dashboard you requested either does not exist or you don't have the required permissions to perform this action.\"],\"errors\":{}}"
    }
  ]
}