Atlassian · Example Payload

Atlassian Atlassianaddonpropertiesresourceputapppropertyput Example

CodeCollaborationPlatformProductivitySoftware Development

Atlassian Atlassianaddonpropertiesresourceputapppropertyput 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": "atlassianAddonpropertiesresourcePutapppropertyPut",
  "method": "PUT",
  "path": "/rest/forge/1/app/properties/{propertyKey}",
  "summary": "Atlassian Set App Property Forge",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "message": "Property updated.",
        "statusCode": 200
      }
    },
    {
      "status": "201",
      "contentType": "application/json",
      "example": {
        "message": "Property created.",
        "statusCode": 201
      }
    },
    {
      "status": "400",
      "contentType": "application/json",
      "example": {
        "message": "The property key can't be longer than 127 characters.",
        "statusCode": 400
      }
    },
    {
      "status": "403",
      "contentType": "application/json",
      "example": {
        "errorMessages": [
          "Access to this resource must be authenticated as an app."
        ]
      }
    }
  ]
}