Countermeasure Notes References

Get all references of a Countermeasure note

This endpoint returns a list of Countermeasure note reference resources.

GET /api/v2/projects/{project_id}/tasks/{task_id}/notes/{note_id}/references/

URL parameters

Parameter Description
project_id The id of the Project.
task_id The id of the Countermeasure.
note_id The id of the Countermeasure Note.

Query parameters

The following parameters may be used to filter the Countermeasure note reference resources in the response.

Fields Description
issue_tracker_connection The id of the Issue Tracker Connection. 
GET /api/v2/projects/1/tasks/1-T2/notes/3/references/ HTTP/1.1
Accept: application/json
Authorization: Token "YOUR SDE ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json

{
    "results": [
        {
            "id": 80,
            "reference": "111",
            "issue_tracker_connection": 1,
            "created": "2025-03-26T14:47:15.107129-04:00",
            "updated": "2025-03-26T14:47:15.107139-04:00",
            "link": "https://my-company.atlassian.net/rest/api/2/issue/1000/comment/111",
            "source": "sde"
        },
        {
            "id": 81,
            "reference": "112",
            "issue_tracker_connection": 2,
            "created": "2025-03-26T14:47:15.107295-04:00",
            "updated": "2025-03-26T14:47:15.107304-04:00",
            "link": "https://my-company.atlassian.net/rest/api/2/issue/1000/comment/112",
            "source": "sde"
        }
    ]
}

Get a specific reference of a Countermeasure note

This endpoint returns a single Countermeasure note reference resource.

GET /api/v2/projects/{project_id}/tasks/{task_id}/references/{reference_id}/

URL parameters

Parameter Description
project_id The id of the Project.
task_id The id of the Countermeasure.
note_id The id of the Countermeasure note.
reference_id The id of the Countermeasure note reference. 
GET /api/v2/projects/1/tasks/1-T2/notes/3/references/80/ HTTP/1.1
Accept: application/json
Authorization: Token "YOUR SDE ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json

{
    "id": 80,
    "reference": "111",
    "issue_tracker_connection": 1,
    "created": "2025-03-26T14:47:15.107129-04:00",
    "updated": "2025-03-26T14:47:15.107139-04:00",
    "link": "https://my-company.atlassian.net/rest/api/2/issue/1000/comment/111",
    "source": "sde"
}

Create a reference for a Countermeasure note

POST /api/v2/projects/{project_id}/tasks/{task_id}/notes/{note_id}/references/

URL parameters

Parameter Description
project_id The id of the Project.
task_id The id of the Countermeasure.
note_id The id of the Countermeasure Note.

Payload

Fields Required Description
issue_tracker_connnection Yes The id of the Issue Tracker Connection.
source Yes The authoritative source of the Countermeasure note reference (sde, issue_tracker).
link No The external link reference.
reference Yes The id of the external link reference. 
POST /api/v2/projects/1/tasks/1-T2/notes/3/references/ HTTP/1.1
Accept: application/json
Authorization: Token "YOUR SDE ACCESS TOKEN"

{
    "issue_tracker_connection": 1,
    "source": "sde",
    "link": "https://my-company.atlassian.net/rest/api/2/issue/1000/comment/111",
    "reference": "111"
}

HTTP/1.1 201 CREATED
Content-Type: application/json

{
    "id": 82,
    "reference": "111",
    "issue_tracker_connection": 1,
    "created": "2025-03-26T16:53:09.623070-04:00",
    "updated": "2025-03-26T16:53:09.623080-04:00",
    "link": "https://my-company.atlassian.net/rest/api/2/issue/1000/comment/111",
    "source": "sde"
}

Update a reference for a Countermeasure note

PATCH /api/v2/projects/{project_id}/tasks/{task_id}/notes/{note_id}/references/{reference_id}/

URL parameters

Parameter Description
project_id The id of the Project.
task_id The id of the Countermeasure.
note_id The id of the Note.
reference_id The id of the Countermeasure note reference.

Payload

Fields Required Description
link No The external link reference.
reference No The id of the external link reference. 
PATCH /api/v2/projects/1/tasks/1-T2/notes/3/references/82/ HTTP/1.1
Accept: application/json
Authorization: Token "YOUR SDE ACCESS TOKEN"

{
    "link": "https://my-company.atlassian.net/rest/api/2/issue/1000/comment/112",
    "reference": "112"
}

HTTP/1.1 200 OK
Content-Type: application/json

{
    "id": 82,
    "reference": "112",
    "issue_tracker_connection": 1,
    "created": "2025-03-26T16:53:09.623070-04:00",
    "updated": "2025-03-26T17:09:12.160049-04:00",
    "link": "https://my-company.atlassian.net/rest/api/2/issue/1000/comment/112",
    "source": "sde"
}

results matching ""

    No results matching ""