Countermeasure References

Get all references of a Countermeasure

Returns a list of Countermeasure Reference resources for a given project Countermeasure.

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

URL parameters

Parameter Description
project_id The id of the project.
task_id The id of the Countermeasure. 
GET /api/v2/projects/1/tasks/1-T21/references/ HTTP/1.1
Accept: application/json
Authorization: Token "YOUR SDE ACCESS TOKEN"

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

{
  "results": [
    {
      "id": 1,
      "issue_tracker_connection": 2,
      "reference": "47300",
      "name": "PROJ-450",
      "link": "https://atlassian.net/browse/PROJ-450"
    },
    {
      "id": 2,
      "issue_tracker_connection": 3,
      "reference": "47301",
      "name": "PROJ-451",
      "link": "https://atlassian.net/browse/PROJ-451"
    }
  ]
}

Get a specific Countermeasure reference

Returns a single Countermeasure reference resource, as specified by the project_id, task_id, and reference_id parameters.

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.
reference_id The id of the Countermeasure reference. 
GET /api/v2/projects/1/tasks/1-T21/references/1/ HTTP/1.1
Accept: application/json
Authorization: Token "YOUR SDE ACCESS TOKEN"

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

{
  "id": 1,
  "issue_tracker_connection": 2,
  "reference": "47300",
  "name": "PROJ-450",
  "link": "https://atlassian.net/browse/PROJ-450"
}

Create a Countermeasure reference

Creates a new Countermeasure reference resource for a given project Countermeasure.

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

URL parameters

Parameter Description
project_id The id of the project
task_id The id of the Countermeasure

Payload

Fields Required Description
issue_tracker_connection Yes The issue tracker connection id.
reference Yes The internal identifier assigned to the Countermeasure by the issue tracker. This is used to find the Countermeasure in a later sync.
name Yes A user-friendly identifier for the Countermeasure in the issue tracker. For example, "PROJ-123".
link Yes A user-facing link to the Countermeasure in the issue tracker. 
POST /api/v2/projects/1/tasks/1-T2/references/ HTTP/1.1
Accept: application/json
Authorization: Token "YOUR SDE ACCESS TOKEN"

{
    "issue_tracker_connection": 561,
    "reference": "123456789",
    "name": "US1314",
    "link": "https://rally1.rallydev.com/#/297113034284d/detail/userstory/371445950616"
}

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

{
    "id": 4177,
    "issue_tracker_connection": 561,
    "reference": "123456789",
    "name": "US1314",
    "link": "https://rally1.rallydev.com/#/297113034284d/detail/userstory/371445950616"
}

Update a Countermeasure reference

Updates a single Countermeasure reference resource, as specified by the project_id, task_id, and reference_id parameters.

PATCH /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.
reference_id The id of the Countermeasure reference.

Payload

Fields Required Description
issue_tracker_connection No The issue tracker connection id.
reference No The internal identifier assigned to the Countermeasure by the issue tracker. This is used to find the Countermeasure in a later sync.
name No A user-friendly identifier for the Countermeasure in the issue tracker. For example, "PROJ-123".
link No A user-facing link to the Countermeasure in the issue tracker. 
PATCH /api/v2/projects/1/tasks/1-T2/references/5/ HTTP/1.1
Accept: application/json
Authorization: Token "YOUR SDE ACCESS TOKEN"

{
    "reference": "NEW_REFERENCE"
}

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

{
    "issue_tracker_connection": 561,
    "reference": "987654321",
    "name": "US1314",
    "link": "https://rally1.rallydev.com/#/297113034284d/detail/userstory/371445950616"
}

Delete a Countermeasure reference

Deletes a single Countermeasure reference resource, as specified by the project_id, task_id, and reference_id parameters.

DELETE /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.
reference_id The id of the Countermeasure reference. 
DELETE /api/v2/projects/1/tasks/1-T2/references/5/ HTTP/1.1
Accept: application/json
Authorization: Token "YOUR SDE ACCESS TOKEN"

HTTP/1.1 204 NO CONTENT

results matching ""

    No results matching ""