Authorization

Basic auth is used for authorization. Therefore you need to create an API token and use it as a username in the following format: tokenLabel@instanceName.atlassian.net. The password is API token itself. You can also use our Postman collection for this and define {{tokenLabel}}, {{instanceName}} and {{apiToken}} as variables:

To get an API token, go to Settings → Apps → STAGIL Assets → API tokens → Create API Token.

Requests

Get Links

Method: GET

API call: https://apps.stagil.com/sajc/rest/saj/1.0/api/assets/issueLink/issue/:issueIdOrKey

Requires ‘Browse project’ permission.

Create Link

Method: POST

API call: https://apps.stagil.com/sajc/rest/saj/1.0/api/assets/issueLink/issue/:issueIdOrKey/customField/:customFieldId

Requires ‘Edit issue’ permission.

 Example response

Delete Link

Method: DELETE

API call: https://apps.stagil.com/sajc/rest/saj/1.0/api/assets/issueLink/customField/:customFieldId/issue/:issueIdOrKey/linkedIssue/:linkedIssueIdOrKey"

Trigger SQL database synchronisation

Method: GET

Description: starts database synchronisation.

API call: https://apps.stagil.com/sajc/rest/saj/1.0/api/assets/synchronizer/{id}/run

SQL database synchronisation status

Method: GET

Description: shows database synchronisation status.

API call: https://apps.stagil.com/sajc/rest/saj/1.0/api/assets/synchronizer/{id}/status

Stop SQL database synchronisation

Method: GET

Description: stops database synchronisation status.

API call: https://apps.stagil.com/sajc//rest/saj/1.0/api/assets/synchronizer/{id}/stop

Parameters

instanceName: Your Jira Cloud instance name (part of URL before the \".atlassian.net\" and after the \"https://\")

customFieldId: Id of the relation custom field.

issueIdOrKey: Id or key of the issue, where a relations table is present.

linkedIssueIdOrKey: Id or key of the linked issue.

Postman Collection