Atlassian · Example Payload

Atlassian Atlassianaddonpropertiesresourcegetaddonpropertyget Example

CodeCollaborationPlatformProductivitySoftware Development

Atlassian Atlassianaddonpropertiesresourcegetaddonpropertyget 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": "atlassianAddonpropertiesresourceGetaddonpropertyGet",
  "method": "GET",
  "path": "/rest/atlassian-connect/1/addons/{addonKey}/properties/{propertyKey}",
  "summary": "Atlassian Get App Property",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "self": "https://your-domain.atlassian.net/jira/rest/atlassian-connect/1/addon/example.app.key/properties/propertyKey",
        "key": "propertyKey",
        "value": "propertyValue"
      }
    },
    {
      "status": "400",
      "contentType": "application/json",
      "example": {
        "message": "The property key cannot be longer than 127 characters.",
        "statusCode": 400
      }
    },
    {
      "status": "401",
      "contentType": "application/json",
      "example": {
        "message": "Access to this resource must be authenticated as an app.",
        "statusCode": 401
      }
    },
    {
      "status": "404",
      "contentType": "application/json",
      "example": {
        "message": "Property with key not found.",
        "statusCode": 404
      }
    }
  ]
}