Resource: Script Assignments ( /api/scriptassignments )

Script Assignments collection resource

Root Relation: ScriptAssignments

This resource supports the following methods: GET, POST

Methods

GET

Retrieves all (or a subset) of script assignments that are visible. 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/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).

Status	Description
200 - OK	Returned if the request was completed successfully.

Example - GET (filtered by TQL Query)

Retrieves all script assignments matching a TQL query.

Request Headers

Key	Value	Description
Accept	application/json

Request Parameters

Key	Value	Description
tql	Name ~ 'Report'	The TQL query to execute.
$top	5	The maximum number of results to return (defaults to 25).
$skip	0	The number of results to skip before return the $top number of results matching the query

Response Headers

Key	Value	Description
Content-Type	application/json; charset=utf-8

Response Body

Code Block

language	none

{
  "Skip": 0,
  "Top": 5,
  "Total": 1,
  "Items": [
    {
      "Id": "3fa6ec13-3939-45b6-beb1-dd03e00a83f9",
      "ScriptId": "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/scriptassignment/3fa6ec13-3939-45b6-beb1-dd03e00a83f9",
      "Links": [
        {
          "Href": "http://localhost/api/scriptassignment/3fa6ec13-3939-45b6-beb1-dd03e00a83f9/allrelationships",
          "Rel": "AllRelationships"
        },
        {
          "Href": "http://localhost/api/executionpackage/f6ed1282-bd89-4f8f-8e94-47e344bba905",
          "Rel": "ExecutionPackage"
        },
        {
          "Href": "http://localhost/api/scriptassignment/3fa6ec13-3939-45b6-beb1-dd03e00a83f9/relationships",
          "Rel": "Relationships"
        },
        {
          "Href": "http://localhost/api/scriptassignment/3fa6ec13-3939-45b6-beb1-dd03e00a83f9/runs",
          "Rel": "Runs"
        },
        {
          "Href": "http://localhost/api/script/c6173eab-f684-4d35-8ca7-62851b8df0e1",
          "Rel": "Script"
        }
      ]
    }
  ],
  "Self": "http://localhost/api/api/scriptassignments?tql=Name~'Report'"
}

Status Code

200 - OK

Example - GET (no TQL query)

Retrieves all packages, across all projects.

Request Headers

Key	Value	Description
Accept	application/json

Response Headers

Key	Value	Description
Content-Type	application/json; charset=utf-8

Response Body

Code Block

language	none

{
  "Skip": 0,
  "Top": 25,
  "Total": 2,
  "Items": [
    {
      "Id": "3fa6ec13-3939-45b6-beb1-dd03e00a83f9",
      "ScriptId": "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/scriptassignment/3fa6ec13-3939-45b6-beb1-dd03e00a83f9",
      "Links": [
        {
          "Href": "http://localhost/api/scriptassignment/3fa6ec13-3939-45b6-beb1-dd03e00a83f9/allrelationships",
          "Rel": "AllRelationships"
        },
        {
          "Href": "http://localhost/api/executionpackage/f6ed1282-bd89-4f8f-8e94-47e344bba905",
          "Rel": "ExecutionPackage"
        },
        {
          "Href": "http://localhost/api/scriptassignment/3fa6ec13-3939-45b6-beb1-dd03e00a83f9/relationships",
          "Rel": "Relationships"
        },
        {
          "Href": "http://localhost/api/scriptassignment/3fa6ec13-3939-45b6-beb1-dd03e00a83f9/runs",
          "Rel": "Runs"
        },
        {
          "Href": "http://localhost/api/script/c6173eab-f684-4d35-8ca7-62851b8df0e1",
          "Rel": "Script"
        }
      ]
    },
    {
      "Id": "8be49e2e-590c-485e-a713-ef3e8353e1d5",
      "ScriptId": "c6173eab-f684-4d35-8ca7-62851b8df0e1",
      "Name": "Login password minimum length is 6",
      "Status": "Passed",
      "AssignedTo": "joeb",
      "AssignedToId": "b2a74983-e374-41d4-bf49-bc3c9a5f0e89",
      "PackageId": "f6ed1282-bd89-4f8f-8e94-47e344bba905",
      "Expands": [
        "Package"
      ],
      "Self": "http://localhost/api/scriptassignment/8be49e2e-590c-485e-a713-ef3e8353e1d5",
      "Links": [
        {
          "Href": "http://localhost/api/scriptassignment/8be49e2e-590c-485e-a713-ef3e8353e1d5/allrelationships",
          "Rel": "AllRelationships"
        },
        {
          "Href": "http://localhost/api/executionpackage/f6ed1282-bd89-4f8f-8e94-47e344bba905",
          "Rel": "ExecutionPackage"
        },
        {
          "Href": "http://localhost/api/scriptassignment/8be49e2e-590c-485e-a713-ef3e8353e1d5/relationships",
          "Rel": "Relationships"
        },
        {
          "Href": "http://localhost/api/scriptassignment/8be49e2e-590c-485e-a713-ef3e8353e1d5/runs",
          "Rel": "Runs"
        },
        {
          "Href": "http://localhost/api/script/c6173eab-f684-4d35-8ca7-62851b8df0e1",
          "Rel": "Script"
        }
      ]
    }
  ],
  "Self": "http://localhost/api/api/scriptassignments"
}

Status Code

200 - OK

POST

Creates a new test script assignment.

Required Permissions

TestManagement/ManageExecution

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).

Status	Description
201 - Created	Returned if the script assignment was created successfully.
403 - Forbidden	Returned if the request could not be completed successfuly (normally due to lack of permissions or validation failure).

Example - POST (no assignee)

Create a new test script assignment, with no assignee.

Request Headers

Key	Value	Description
Accept	application/json

Request Body

Code Block

language	none

{
  "PackageId": "f6ed1282-bd89-4f8f-8e94-47e344bba905",
  "ScriptId": "5ef6c545-6ef8-472e-bae7-b1cc3d3fbab0"
}

Response Headers

Key	Value	Description
Location	http://localhost/api/scriptassignment/4bb709c2-e0e7-4af3-9f60-a045016a9610
Content-Type	application/json; charset=utf-8

Response Body

Code Block

language	none

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

Status Code

201 - Created

Example - POST (with assignee)

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

Request Headers

Key	Value	Description
Accept	application/json

Request Body

Code Block

language	none

{
  "PackageId": "f6ed1282-bd89-4f8f-8e94-47e344bba905",
  "AssignedToId": "5bb78013-222a-45a8-b639-ac0ce0a8a505",
  "ScriptId": "5ef6c545-6ef8-472e-bae7-b1cc3d3fbab0"
}

Response Headers

Key	Value	Description
Location	http://localhost/api/scriptassignment/4bb709c2-e0e7-4af3-9f60-a045016a9610
Content-Type	application/json; charset=utf-8

Response Body

Code Block

language	none

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

Status Code

201 - Created

Child pages

Versions Compared

Old Version 2

New Version 3

Key

Resource: Script Assignments ( /api/scriptassignments )

Methods

GET

Required Permissions

Supported Expansions

Status Codes

POST

Required Permissions

Supported Expansions

Status Codes

Child pages

Page History

Versions Compared

Old Version 2

New Version 3

Key

Resource: Script Assignments ( /api/scriptassignments )

Methods

GET

Required Permissions

Supported Expansions

Status Codes

POST

Required Permissions

Supported Expansions

Status Codes