This resource represents Issue Redaction. Provides APIs to redact issue data.
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.
redact:issue:jiraConnect apps cannot access this REST resource.
List of redaction requests
array<SingleRedactionRequest>
Returned if the job submission is successful. The response contains the job id.
string
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
curl --request POST \
--url 'https://your-domain.atlassian.net/rest/api/3/redact' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"redactions": [
{
"contentItem": {
"entityId": "summary",
"entityType": "issuefieldvalue",
"id": "10000"
},
"externalId": "51101de6-d001-429d-a095-b2b96dd57fcb",
"reason": "PII data",
"redactionPosition": {
"adfPointer": "/content/0/content/0/text",
"expectedText": "ODFiNjM3ZDhmY2QyYzZkYTYzNTllNjk2MzExM2ExMTcwZGU3OTVlNGI3MjViODRkMWUwYjRjZmQ5ZWM1OGNlOQ==",
"from": 14,
"to": 20
}
}
]
}'1
"<string>"Retrieves the current status of a redaction job ID.
The jobStatus will be one of the following:
redact:issue:jiraConnect apps cannot access this REST resource.
string
RequiredReturned if the job status is successfully retrieved.
1
2
3
4
curl --request GET \
--url 'https://your-domain.atlassian.net/rest/api/3/redact/status/{jobId}' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
{
"bulkRedactionResponse": {
"results": [
{
"externalId": "<string>",
"successful": true
}
]
},
"jobStatus": "PENDING"
}Rate this page: