You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 7 Next »

This API is dedicated to use when users have no access to JWT. User must have Jira Permission to browse users and groups.

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

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

This endpoint allows to get all Secure field values for the given issue. Only users with READ permission can see the secure values.

issueId - id of the issue.

[
    {
        "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
    }
]

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.

GlobalConfigurationId of the Secure field is required and can be obtained by using a GET endpoint described above.

issueId - id of the issue.

Fields with value are mapped to:

textFieldValue - Secure Text Single Line, Secure Text Multi Line

numericFieldValue - Secure Number

dateFieldValue - Secure Date

dateTimeFieldValue - Secure Date Time.

Request body example:

[
  {
    "globalConfigurationId": "globalConfigurationId",
    "textFieldValue": "text",
    "numberFieldValue": 500,
    "dateFieldValue": "2020-01-08",
    "dateTimeFieldValue": "2020-01-08 17:09:42"
  }
]

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

where issueId is the id of the issue.

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

Parameters as page ($int32) and size ($int32) are required.

  • No labels