...
Go to Manage Apps → Macro for Assets → Configuration
Click the API tab.
...
To enable API access you need to generate an access token.
Click the Generate Access Token - button to generate one or more tokens.
By default the access token will be applicable for all projects spaces with Read and Write permissions.
Click the Edit link to edit token permissions
...
token = the access token (scope must be READ and projects space must match issue projectpage space)
pageId = the page to read macro configuration values from
...
Response Body:
| Code Block | ||
|---|---|---|
| ||
[
[
{
"id": "rxt-95ae25ba-0759-4b4e-a40f-edbdc7194067",
"configuration": {
"columns": [],
"iql": "objectType=\"Jira Users\"",
"displayAs": "AS_TABLE",
"pageSize": 5,
"schemaId": "4",
"connectionId": "45157a8a-79ad-46f7-b920-c21211bf79ec",
"tableOptions": {
"linksEnabled": true,
"downloadEnabled": false,
"printEnabled": false
}
}
}
] |
400 BAD REQUEST When request is invald
Body:
Error message describing the problem
| Info |
|---|
Note: Verify parameters to resolve this issue |
401 UNAUTHORIZED When request is unauthorized.
...
token = the access token (scope must be WRITE and projects space must match issue projectpage space)
pageId = the page to store the macro config on values from
...
An array of macro configuration, use multiple configuration JSON objects to update multiple configuration configurations on the page. Note: To update a single value this still has to be an array containing the single value entity.
...
200 OK When request is valid and value was updated
Body: OK
400 BAD REQUEST When request is invalid
Body:Bad Request
...
| Code Block |
|---|
{
"status": "SUCCESS",
"message": "Macro for pageId 1979514881 has been updated!"
} |
400 BAD REQUEST When request is invalid
Body:Bad Request
| Info |
|---|
Note: Verify parameters to resolve this issue |
401 UNAUTHORIZED When request is unauthorized.
...
token = the access token (scope must be WRITE and projects space must match issue projectspaceKey)
spaceKey = the spaceKey to store the page with macro config on.
...
200 OK When request is valid and value was updated
Body: OK
400 BAD REQUEST When request is invalid
Body:Bad
| Code Block |
|---|
{
"status": "SUCCESS",
"message": "Page has been created with Macro for space fff, new page(s) are 1979514881",
"newPages": [
"1979514881"
]
} |
400 BAD REQUEST When request is invalid
Body:Bad Request
| Info |
|---|
Note: Verify parameters to resolve this issue |
...
token = the access token (scope must be WRITE and projects spaces must match issue projectboth spaceKey for destination space and page space)
spaceKey = the spaceKey to store the page with macro config on.
pageId = the page to store read the macro config on values from
...