...
Method | URI | Query Params | Token Scope | Token Space(s) | Description | |||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| api_url found on API page of Macro Configuration | pageId token |
| can be limited using space list or empty to allow all spaces. | Returns an array of Macro for Assets configuration for a specific page using pageId paramquery parameter.
| |||||||||||||||||||||||
| api_url found on API page of Macro Configuration | pageId token |
| can be limited using space list or empty to allow all spaces. | Updates all Macro for Assets configuration specified in the body for a specific page using pageId param. Use
Example;
body:
| |||||||||||||||||||||||
| api_url found on API page of Macro Configuration | spaceKey token |
| can be limited using space list or empty to allow all spaces. | Creates one or more new page(s) with Macro for Assets added and pre-configured. spaceKey determine what space to add the page in. Body takes an array of pages title and parent with macro configuration. Example;
body:
| |||||||||||||||||||||||
| api_url/copyspaceKey found on API page of Macro Configuration | pageId spaceKey token |
| can be limited using space list or empty to allow all spaces. | Copies one page and creates one or more new page(s) with Macro for Assets added and pre-configured. spaceKey determine what space to add the page in. pageId determine the page to copy. Body takes an array of pages with macro configuration Example;
body:
|
...
200 OK (application/json) When request is valid
Response Body:
| Code Block | ||
|---|---|---|
| ||
[ [ { "id":"..." "rxt-95ae25ba-0759-4b4e-a40f-edbdc7194067", "configuration": { }, "columns": ] |
400 BAD REQUEST When request is invald
Body:
Error message
Note: Verify parameters to resolve this issue
401 UNAUTHORIZED When request is unauthorized.
Body:
Error message
| Info |
|---|
Note: Verify access token permissions to resolve this issue |
Update Macro for Asset configuration via API
Make a HTTP PUT (or POST) request to the URL available on your API page.
...
Required parameters:
token = the access token (scope must be WRITE and projects must match issue project)
pageId = the page to store the macro config on values from
Required post body:
An array of field entities, use multiple entities to update multiple field values. Note: To update a single value this still has to be an array containing the single value entity.
| Code Block |
|---|
[
{
macro config....
}
] |
Response:
200 OK When request is valid and value was updated
Body: OK
400 BAD REQUEST When request is invalid
Body:Bad Request
[],
"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
Note: Verify parameters to resolve this issue
401 UNAUTHORIZED When request is unauthorized.
Body: Unauthorized
Error message
| Info |
|---|
Note: Verify access token permissions to resolve this issue |
401 BAD REQUEST When request is unauthorized.
Body:Bad Request
| Info |
|---|
Note: Make sure the that the project(s) has Edit Permission: atlassian-addons-project-access Check that the Field exists on the edit screen. |
Create Page with Macro for Asset configuration via API
...
Update Macro for Asset configuration via API
Make a HTTP PUT request to the URL available on your API page.
Use this API when you want to programatically create a page with the Macro for Asset on it with pre-configured settings.
Required parameters:
token = the access token (scope must be WRITE and projects must match issue project)
pageId = the page to store the macro config on values from
Required post body:
An array of field entities, use multiple entities to update multiple field values. Note: To update a single value this still has to be an array containing the single value entity.
...
update Macro for Assets configuration on a page. 
You can read the current macro config using the GET api and then use those IDs to update the macro configuration using this endpoint.
Required parameters:
token = the access token (scope must be WRITE and projects must match issue project)
pageId = the page to store the macro config on values from
Required post body:
An array of macro configuration, use multiple configuration JSON objects to update multiple configuration on the page. Note: To update a single value this still has to be an array containing the single value entity.
| Code Block |
|---|
[
{
"id": "rxt-95ae25ba-0759-4b4e-a40f-edbdc7194067",
"configuration": {
"columns": [],
"iql": "objectType=\"Okta Policies\"",
"displayAs": "AS_TABLE",
"pageSize": 5,
"schemaId": "4",
"connectionId": "45157a8a-79ad-46f7-b920-c21211bf79ec",
"tableOptions": {
"linksEnabled": true,
"downloadEnabled": false,
"printEnabled": false
}
}
}
] |
Response:
200 OK When request is valid and value was updated
Body: OK
400 BAD REQUEST When request is invalid
Body:Bad Request
| Info |
|---|
Note: Verify parameters to resolve this issue |
401 UNAUTHORIZED When request is unauthorized.
Body: Unauthorized
| Info |
|---|
Note: Verify access token permissions to resolve this issue |
Create Page with Macro for Asset configuration via API
Make a HTTP POST request to the URL available on your API page.
Use this when you want to programatically create a new page with the Macro for Asset on it with pre-configured settings.
Required parameters:
token = the access token (scope must be WRITE and projects must match issue project)
spaceKey = the spaceKey to store the page with macro config on.
Required post body:
An array of pages with macro configuration. Note: To update a single value this still has to be an array containing the single value entity.
Each array object takes a title and optional parenPageId and the list of macros to add.
| Code Block |
|---|
[
{
"title":"NY page",
"parentPageId":1977778177,
"macros":[
{
"id": "",
"configuration": {
"columns": [],
"iql": "objectType=\"Jira Users\"",
"displayAs": "AS_ITEM",
"pageSize": 5,
"schemaId": "4",
"connectionId": "45157a8a-79ad-46f7-b920-c21211bf79ec",
"tableOptions": {
"linksEnabled": true,
"downloadEnabled": false,
"printEnabled": false
}
}
}
]
}
]
|
Response:
200 OK When request is valid and value was updated
Body: OK
400 BAD REQUEST When request is invalid
Body:Bad Request
| Info |
|---|
Note: Verify parameters to resolve this issue |
401 UNAUTHORIZED When request is unauthorized.
Body: Unauthorized
| Info |
|---|
Note: Verify access token permissions to resolve this issue |
Copy Page with Macro for Asset configuration via API
Make a HTTP PATCH request to the URL available on your API page.
Use this when you want to programatically copy a page and create one or more copies of that page with the Macro for Asset on it with pre-configured settings.
Required parameters:
token = the access token (scope must be WRITE and projects must match issue project)
spaceKey = the spaceKey to store the page with macro config on.
pageId = the page to store the macro config on values from
Required post body:
An array of pages with macro configuration. Note: To update a single value this still has to be an array containing the single value entity.
Each array object takes a title and optional parenPageId and the list of macros to add.
| Code Block |
|---|
[
{
"title":"NY page",
"parentPageId":1977778177,
"macros":[
{
"id": "",
"configuration": {
"columns": [],
"iql": "objectType=\"Jira Users\"",
"displayAs": "AS_ITEM",
"pageSize": 5,
"schemaId": "4",
"connectionId": "45157a8a-79ad-46f7-b920-c21211bf79ec",
"tableOptions": {
"linksEnabled": true,
"downloadEnabled": false,
"printEnabled": false
}
}
}
]
}
]
|
Response:
200 OK When request is valid and value was updated
...
| Info |
|---|
Note: Verify access token permissions to resolve this issue |
401 BAD REQUEST When request is unauthorized.
Body:Bad Request
| Info |
|---|
Note: Make sure the that the project(s) has Edit Permission: atlassian-addons-project-access Check that the Field exists on the edit screen. |