Set app property (Forge)

PUT

/rest/forge/1/app/properties/{propertyKey}

Sets the value of a Forge app's property.
These values can be retrieved in Jira expressions
through the app context variable.

For other use cases, use the Storage API.

The value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.

Permissions required: Only Forge apps can make this request.

请求示例

Shell

JavaScript

Java

Swift

curl --location -g --request PUT 'http:///rest/forge/1/app/properties/' \
--header 'Content-Type: application/json' \
--data-raw 'null'

响应示例

200 - 成功示例

{
    "message": "Property updated.",
    "statusCode": 200
}

请求参数

Path 参数

Body 参数application/json

示例

🟢200Returned if the property is updated.

application/json

Body

🟢201Returned is the property is created.

🟠400Returned if: * the property key is longer than 127 characters. * the value isn't valid JSON. * the value is longer than 32768 characters.

🟠401Returned if the authentication credentials are incorrect or missing.

🟠403Returned if the request isn't made directly by an app or if it's an impersonated request.

修改于 2023-07-12 08:28:12