Atlassian · Example Payload

Atlassian Atlassianupdategadget Example

CodeCollaborationPlatformProductivitySoftware Development

Atlassian Atlassianupdategadget 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": "atlassianUpdategadget",
  "method": "PUT",
  "path": "/rest/api/3/dashboard/{dashboardId}/gadget/{gadgetId}",
  "summary": "Atlassian Update Gadget On Dashboard",
  "requestExamples": [
    {
      "contentType": "application/json",
      "example": {
        "color": "red",
        "position": {
          "column": 1,
          "row": 1
        },
        "title": "My new gadget title"
      }
    }
  ],
  "responseExamples": [
    {
      "status": "400",
      "contentType": "application/json",
      "example": "{\"errorMessages\":[\"The gadget cannot be placed in the selected row. The selected row does not exist on the dashboard.\"],\"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\":{}}"
    }
  ]
}