Versions Compared

Old Version 15

changes.mady.by.user Inga

Saved on

compared with

New Version 16

changes.mady.by.user Inga

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info

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

...

Integration API is available on sfapp.almarise.com

Integration API is available on sfapp.almarise.com

Get Value

Panel
bgColor#DEEBFF

GET​/integration​/app​/rest​/api​/v1​/secure-field​/value​/{issueId}

...

Expand
titleResponse example
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
bgColor#E3FCEF

POST​/integration​/app​/rest​/api​/v1​/secure-field​/value​/{issueId}

Endpoint updates all Secure field values for the given issue. Only users with WRITE permission can update values.

...

Expand
titleResponse example
Code Block
[
    {
        "globalConfigurationId": "64d25ee1ae45d1595276f16a",
        "textFieldValue": null,
        "numberFieldValue": 500.0,
        "dateFieldValue": null,
        "dateTimeFieldValue": null
    }
]

Get History

Panel
bgColor#DEEBFF

GET​/integration​/app​/rest​/api​/v1​/secure-field​/history​/{issueId}

Get Secure fields history records. Only users with HISTORY permission can access the records.

...