Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

This resource supports the following methods: DELETE, GET, PATCH, PUT

Methods

DELETE

...

Delete script run by its unique identifier.

...

Example - GET Example

Retrieves a script by its unique identifier.

Request Headers

KeyValueDescription
Acceptapplication/json

Request Parameters

KeyValueDescription
{id}74A91027-C1FB-46FF-B0F9-471F7D8DB2BCUnique identifier of script run.

Response Headers

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

Response Body

Code Block
languagenone
{
  "Id": "74a91027-c1fb-46ff-b0f9-471f7d8db2bc",
  "ActualDuration": "5 minutes",
  "ScriptId": "15710485-6aba-4158-8b67-4e0120bc8c09",
  "ScriptVersion": 1,
  "AssignmentId": "6cb9a282-53b0-4acb-91f3-10363adfecf9",
  "CreatedAt": "2012-01-01T14:04:05Z",
  "LastUpdatedAt": "2012-02-02T15:05:06Z",
  "CreatedById": "e4051ca5-c8e5-4068-a177-66fa30708460",
  "CreatedBy": "joeb",
  "RunById": "e4051ca5-c8e5-4068-a177-66fa30708460",
  "RunBy": "joeb",
  "LastUpdatedById": "e4051ca5-c8e5-4068-a177-66fa30708460",
  "LastUpdatedBy": "joeb",
  "Status": "In Progress",
  "Expands": [
    "Assignment",
    "Widgets",
    "FieldValues",
    "StepResults"
  ],
  "Self": "http://localhost/api/scriptrun/74a91027-c1fb-46ff-b0f9-471f7d8db2bc"
}

Status Code

200 - OK

PATCH

...

Updates a script run.

Required Permissions

  • TestManagement/ManageExecutions/Edit

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
204 - NoContentReturned if it updated the script run successfully.
403 - ForbiddenReturned if you do not have permission to update the script run.
404 - NotFoundReturned if no script run with that identifier exists.

PUT

...

Updates a script run.

Required Permissions

  • TestManagement/ManageExecutions/Edit

...

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

...