Issue redaction

Redact

Submit a job to redact issue field data. This will trigger the redaction of the data in the specified fields asynchronously.

The redaction status can be polled using the job id.

post/rest/api/2/redact

Request

  • Base URL: https://your-domain.atlassian.net
  • URL: https://your-domain.atlassian.net/rest/api/2/redact
  • Auth: HTTP basic

Request body

Example request

{
  "redactions": [
    {
      "contentItem": {
        "entityId": "summary",
        "id": "10000"
      },
      "externalId": "51101de6-d001-429d-a095-b2b96dd57fcb",
      "reason": "PII data",
      "redactionPosition": {
        "adfPointer": "/content/0/content/0/text",
        "expectedText": "ODFiNjM3ZDhmY2QyYzZkYTYzNTllNjk2MzExM2ExMTcwZGU3OTVlNGI3MjViODRkMWUwYjRjZmQ5ZWM1OGNlOQ==",
        "from": 14,
        "to": 20
      }
    }
  ]
}

Response

Returned if the job submission is successful. The response contains the job id.

string uuid required

Changes

No recorded changes to this operation across all 26 revisions of this API.