Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

Resource: Test Automated Test Assignments ( /api/automatedtest/{testId}/assignments )

Automated Test Assignments collection resource (Assignments associated with a single automated test).

This resource supports the following methods: GET, POST

Methods

GET


Retrieves all (or a subset) of automated test assignments that are visible associated with the automated test. This method takes a TQL query.

This method supports the TQL query parameters tql, $top, $take and $inlinecount. See TQL Topic for more details.

Required Permissions

  • TestManagement/ManageExecutions/View
  • TestManagement/ManageScripts/View

Supported Expansions

For more details on expansions, please see the Expand help topic.

Status Codes

These are the expected status codes returned by the service. In addition, some other status codes may be returned if either an internal error occurs or there is an authentication issue (such as an expired OAuth token).

StatusDescription
200 - OKReturned if the request is completed successfully.
404 - NotFoundReturned if the automated test does not exist.

Example - GET (filtered by TQL Query)

Retrieves all assignments for the automated test that match the supplied TQL query.

Request Headers

KeyValueDescription
Acceptapplication/json

Request Parameters

KeyValueDescription
tqlPackage = 'Cycle 1'The TQL query to execute.
$top5The Maximum number of results to return (defaults to 25).
$skip0The number of results to skip before return the $top number of results matching the query
{testId}c6173eab-f684-4d35-8ca7-62851b8df0e1Unique identifier of the autoamted test

Response Headers

KeyValueDescription
Content-Typeapplication/json; charset=utf-8

Response Body

Code Block
languagenone
{
  "Skip": 0,
  "Top": 5,
  "Total": 1,
  "Items": [
    {
      "Id": "3fa6ec13-3939-45b6-beb1-dd03e00a83f9",
      "AutomatedTestId": "c6173eab-f684-4d35-8ca7-62851b8df0e1",
      "Name": "Report output paging",
      "Status": "Not Run",
      "AssignedTo": "joeb",
      "AssignedToId": "b2a74983-e374-41d4-bf49-bc3c9a5f0e89",
      "PackageId": "f6ed1282-bd89-4f8f-8e94-47e344bba905",
      "Expands": [
        "Package"
      ],
      "Self": "http://localhost/api/automatedtestassignment/3fa6ec13-3939-45b6-beb1-dd03e00a83f9",
      "Links": [
        {
          "Href": "http://localhost/api/automatedtestassignment/3fa6ec13-3939-45b6-beb1-dd03e00a83f9/allrelationships",
          "Rel": "AllRelationships"
        },
        {
          "Href": "http://localhost/api/automatedtest/c6173eab-f684-4d35-8ca7-62851b8df0e1",
          "Rel": "AutomatedTest"
        },
        {
          "Href": "http://localhost/api/executionpackage/f6ed1282-bd89-4f8f-8e94-47e344bba905",
          "Rel": "ExecutionPackage"
        },
        {
          "Href": "http://localhost/api/automatedtestassignment/3fa6ec13-3939-45b6-beb1-dd03e00a83f9/relationships",
          "Rel": "Relationships"
        },
        {
          "Href": "http://localhost/api/automatedtestassignment/3fa6ec13-3939-45b6-beb1-dd03e00a83f9/runs",
          "Rel": "Runs"
        }
      ]
    }
  ],
  "Self": "http://localhost/api/api/automatedtest/C6173EAB-F684-4D35-8CA7-62851B8DF0E1/assignments?tql=Package = 'Cycle 1'"
}

Status Code

200 - OK

Example - GET (no TQL query)

Retrieves all assignments for the automated test.

Request Headers

KeyValueDescription
Acceptapplication/json

Request Parameters

KeyValueDescription
{testId}c6173eab-f684-4d35-8ca7-62851b8df0e1Unique identifier of the autoamted test

Response Headers

KeyValueDescription
Content-Typeapplication/json; charset=utf-8

Response Body

Code Block
languagenone
{
  "Skip": 0,
  "Top": 25,
  "Total": 2,
  "Items": [
    {
      "Id": "3fa6ec13-3939-45b6-beb1-dd03e00a83f9",
      "AutomatedTestId": "c6173eab-f684-4d35-8ca7-62851b8df0e1",
      "Name": "Report output paging",
      "Status": "Not Run",
      "AssignedTo": "joeb",
      "AssignedToId": "b2a74983-e374-41d4-bf49-bc3c9a5f0e89",
      "PackageId": "f6ed1282-bd89-4f8f-8e94-47e344bba905",
      "Expands": [
        "Package"
      ],
      "Self": "http://localhost/api/automatedtestassignment/3fa6ec13-3939-45b6-beb1-dd03e00a83f9",
      "Links": [
        {
          "Href": "http://localhost/api/automatedtestassignment/3fa6ec13-3939-45b6-beb1-dd03e00a83f9/allrelationships",
          "Rel": "AllRelationships"
        },
        {
          "Href": "http://localhost/api/automatedtest/c6173eab-f684-4d35-8ca7-62851b8df0e1",
          "Rel": "AutomatedTest"
        },
        {
          "Href": "http://localhost/api/executionpackage/f6ed1282-bd89-4f8f-8e94-47e344bba905",
          "Rel": "ExecutionPackage"
        },
        {
          "Href": "http://localhost/api/automatedtestassignment/3fa6ec13-3939-45b6-beb1-dd03e00a83f9/relationships",
          "Rel": "Relationships"
        },
        {
          "Href": "http://localhost/api/automatedtestassignment/3fa6ec13-3939-45b6-beb1-dd03e00a83f9/runs",
          "Rel": "Runs"
        }
      ]
    },
    {
      "Id": "8be49e2e-590c-485e-a713-ef3e8353e1d5",
      "AutomatedTestId": "c6173eab-f684-4d35-8ca7-62851b8df0e1",
      "Name": "Report output paging",
      "Status": "Passed",
      "AssignedTo": "joeb",
      "AssignedToId": "b2a74983-e374-41d4-bf49-bc3c9a5f0e89",
      "PackageId": "476dfac2-8c1e-4594-b664-9b75f521ab16",
      "Expands": [
        "Package"
      ],
      "Self": "http://localhost/api/automatedtestassignment/8be49e2e-590c-485e-a713-ef3e8353e1d5",
      "Links": [
        {
          "Href": "http://localhost/api/automatedtestassignment/8be49e2e-590c-485e-a713-ef3e8353e1d5/allrelationships",
          "Rel": "AllRelationships"
        },
        {
          "Href": "http://localhost/api/automatedtest/c6173eab-f684-4d35-8ca7-62851b8df0e1",
          "Rel": "AutomatedTest"
        },
        {
          "Href": "http://localhost/api/executionpackage/476dfac2-8c1e-4594-b664-9b75f521ab16",
          "Rel": "ExecutionPackage"
        },
        {
          "Href": "http://localhost/api/automatedtestassignment/8be49e2e-590c-485e-a713-ef3e8353e1d5/relationships",
          "Rel": "Relationships"
        },
        {
          "Href": "http://localhost/api/automatedtestassignment/8be49e2e-590c-485e-a713-ef3e8353e1d5/runs",
          "Rel": "Runs"
        }
      ]
    }
  ]
}

Status Code

200 - OK

POST


Creates a new automated test assignment for this test.

Required Permissions

  • TestManagement/ManageExecutions/ExecuteAllTests
  • TestManagement/ManageExecutions/ExecuteOnlyMyTests

Supported Expansions

For more details on expansions, please see the Expand help topic.

Status Codes

These are the expected status codes returned by the service. In addition, some other status codes may be returned if either an internal error occurs or there is an authentication issue (such as an expired OAuth token).

StatusDescription
201 - CreatedReturned if the automated test assignment is created successfully.
403 - ForbiddenReturned if the request could not be completed successfuly (normally due to lack of permissions or validation failure).

Example - POST (no assignee)

Create a new automated test assignment, with no assignee.

Request Headers

KeyValueDescription
Acceptapplication/json

Request Parameters

KeyValueDescription
{testId}5EF6C545-6EF8-472E-BAE7-B1CC3D3FBAB0unique identifier for test to create assignment for

Request Body

Code Block
languagenone
{
  "PackageId": "f6ed1282-bd89-4f8f-8e94-47e344bba905"
}

Response Headers

KeyValueDescription
Locationhttp://localhost/api/automatedtestassignment/4bb709c2-e0e7-4af3-9f60-a045016a9610
Content-Typeapplication/json; charset=utf-8

Response Body

Code Block
languagenone
{
  "Id": "4bb709c2-e0e7-4af3-9f60-a045016a9610",
  "AutomatedTestId": "5ef6c545-6ef8-472e-bae7-b1cc3d3fbab0",
  "Name": "My Test",
  "Status": "Not Run",
  "AssignedTo": null,
  "AssignedToId": null,
  "PackageId": "f6ed1282-bd89-4f8f-8e94-47e344bba905",
  "Expands": [
    "Package"
  ],
  "Self": "http://localhost/api/automatedtestassignment/4bb709c2-e0e7-4af3-9f60-a045016a9610",
  "Links": [
    {
      "Href": "http://localhost/api/automatedtestassignment/4bb709c2-e0e7-4af3-9f60-a045016a9610/allrelationships",
      "Rel": "AllRelationships"
    },
    {
      "Href": "http://localhost/api/automatedtest/5ef6c545-6ef8-472e-bae7-b1cc3d3fbab0",
      "Rel": "AutomatedTest"
    },
    {
      "Href": "http://localhost/api/executionpackage/f6ed1282-bd89-4f8f-8e94-47e344bba905",
      "Rel": "ExecutionPackage"
    },
    {
      "Href": "http://localhost/api/automatedtestassignment/4bb709c2-e0e7-4af3-9f60-a045016a9610/relationships",
      "Rel": "Relationships"
    },
    {
      "Href": "http://localhost/api/automatedtestassignment/4bb709c2-e0e7-4af3-9f60-a045016a9610/runs",
      "Rel": "Runs"
    }
  ]
}

Status Code

201 - Created

Example - POST (with assignee)

Create a new automated test assignment, with the assignee set.

Request Headers

KeyValueDescription
Acceptapplication/json

Request Parameters

KeyValueDescription
{testId}5EF6C545-6EF8-472E-BAE7-B1CC3D3FBAB0unique identifier for test to create assignment for

Request Body

Code Block
languagenone
{
  "PackageId": "f6ed1282-bd89-4f8f-8e94-47e344bba905",
  "AssignedToId": "5bb78013-222a-45a8-b639-ac0ce0a8a505"
}

Response Headers

KeyValueDescription
Locationhttp://localhost/api/automatedtestassignment/4bb709c2-e0e7-4af3-9f60-a045016a9610
Content-Typeapplication/json; charset=utf-8

Response Body

Code Block
languagenone
{
  "Id": "4bb709c2-e0e7-4af3-9f60-a045016a9610",
  "AutomatedTestId": "5ef6c545-6ef8-472e-bae7-b1cc3d3fbab0",
  "Name": "My Test",
  "Status": "Not Run",
  "AssignedTo": "joeb",
  "AssignedToId": "5bb78013-222a-45a8-b639-ac0ce0a8a505",
  "PackageId": "f6ed1282-bd89-4f8f-8e94-47e344bba905",
  "Expands": [
    "Package"
  ],
  "Self": "http://localhost/api/automatedtestassignment/4bb709c2-e0e7-4af3-9f60-a045016a9610",
  "Links": [
    {
      "Href": "http://localhost/api/automatedtestassignment/4bb709c2-e0e7-4af3-9f60-a045016a9610/allrelationships",
      "Rel": "AllRelationships"
    },
    {
      "Href": "http://localhost/api/automatedtest/5ef6c545-6ef8-472e-bae7-b1cc3d3fbab0",
      "Rel": "AutomatedTest"
    },
    {
      "Href": "http://localhost/api/executionpackage/f6ed1282-bd89-4f8f-8e94-47e344bba905",
      "Rel": "ExecutionPackage"
    },
    {
      "Href": "http://localhost/api/automatedtestassignment/4bb709c2-e0e7-4af3-9f60-a045016a9610/relationships",
      "Rel": "Relationships"
    },
    {
      "Href": "http://localhost/api/automatedtestassignment/4bb709c2-e0e7-4af3-9f60-a045016a9610/runs",
      "Rel": "Runs"
    }
  ]
}

Status Code

201 - Created