...
| Panel |
|---|
| panelIconId | atlassian-info |
|---|
| panelIcon | :info: |
|---|
| bgColor | #DEEBFF |
|---|
|
This API is dedicated to programmatic integration between Jira and third-party systems, Jira automation, or workflow when JWT is not feasible. In order to to authenticate calls please setup personal access token as described here. Three request headers must be set beforehand: email - email address of the user, who will be accessing API jira-host - address of Jira Cloud instance api-token - token created by the user who will be accessing the API
|
Endpoints
| Panel |
|---|
| panelIconId | atlassian-note |
|---|
| panelIcon | :note: |
|---|
| bgColor | #FFFFFF |
|---|
|
Integration API is available on sfapp.almarise.com |
...
| Expand |
|---|
| title | How do I know where my data is stored? |
|---|
|
The most straightforward way to determine your data location is to send the API request e.g. GET with the following URLs: One of them will return status 200 and the other one - 404. This way you will know that your data is stored in the respective location. |
Get Value
| Panel |
|---|
|
GET/integration/app/rest/api/v1/secure-field/value/{issueId} |
...
| Expand |
|---|
|
| Code Block |
|---|
[
{
"fieldName": "Secure Number field",
"fieldType": "SECURE_NUMBER",
"globalConfigurationId": "64d25ee1ae45d1595276f16a",
"textFieldValue": null,
"numberFieldValue": 7654.0,
"date": null,
"permissions": {
"EDIT": true,
"VIEW": true,
"HISTORY": true
},
"required": false
}
] |
|
Update Value
| Panel |
|---|
|
POST/integration/app/rest/api/v1/secure-field/value/{issueId} |
...
| Expand |
|---|
|
| Code Block |
|---|
[
{
"globalConfigurationId": "64d25ee1ae45d1595276f16a",
"textFieldValue": null,
"numberFieldValue": 500.0,
"dateFieldValue": null,
"dateTimeFieldValue": null
}
] |
|
Get History
| Panel |
|---|
|
GET/integration/app/rest/api/v1/secure-field/history/{issueId} |
...
| Expand |
|---|
|
| Code Block |
|---|
{
"total": 2,
"page": 0,
"pageSize": 10,
"issueId": "10008",
"items": [
{
"authorId": "5e8f9de61c07ed0b7df4063c",
"secureFieldId": "64d25ee1ae45d1595276f16a",
"secureFieldName": "Secure Number field",
"oldValue": "7654.0",
"newValue": "500.0",
"created": 1691509448914
},
{
"authorId": "5e8f9de61c07ed0b7df4063c",
"secureFieldId": "64d25ee1ae45d1595276f16a",
"secureFieldName": "Secure Number field",
"oldValue": null,
"newValue": "7654.0",
"created": 1691508486073
}
]
} |
|
Responses
- OK. Returned if the request is successful.
...