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:

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

Advanced Links

Get Links

Method:

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

(warning) Requires ‘Browse project’ permission.

Create Link

Method:

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

(warning) Requires ‘Edit issue’ permission.

Delete Link

Method:

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

Issue Filters

Panel context: GET Projects in field context

Method:

Description: returns project IDs from the Issue Filter Panel.

https//apps.stagil.com/sajc/rest/saj/1.0/api/assets/context/customField/:customFieldId/project

Parameter: customFieldId

[
    {
        "contextId": "60",
        "contextName": "All Projects:All Issue Types",
        "projectIds": [
            "-1"
        ]
    }
]

Panel context: add new projects to the context

Method:

Description: updates the project list in the field context 

https://apps.stagil.com/sajc/rest/saj/1.0/api/assets/context/:contextId/customField/:customFieldId/project

Parameter: customFieldId, contextId

// list of project IDs 
[
            "10000",
            "10001",
            "10002",
            "10003",
            "10292"
        ]

Database synchronisation

Trigger SQL database synchronisation

Method:

Description: starts database synchronisation.

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

{id} - database synchroniser ID

SQL database synchronisation status

Method:

Description: shows database synchronisation status.

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

{id} - database synchroniser ID

Stop SQL database synchronisation

Method:

Description: stops database synchronisation status.

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

{id} - database synchroniser ID

Parameters

Advanced Links

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.

Issue Filters

customFieldID

contextID

Postman Collection