Resource: Script ( /api/script/{id} )

Script resource

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

Methods

DELETE

Delete a script.

Required Permissions

TestManagement/ManageScripts/Delete

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.
403 - Forbidden	Returned if you don't have the permissions required to delete the script.
404 - NotFound	Returned if script does not exist.

Example - DELETE

Delete a Test Script.

Request Headers

Key	Value	Description
Accept	application/json

Request Parameters

Key	Value	Description
{id}	4bb709c2-e0e7-4af3-9f60-a045016a9610	Unique identifier of the script to delete.

Response Headers

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

Status Code

200 - OK

GET

Retrieves a single script by its unique Identifier.

Required Permissions

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

Status	Description
200 - OK	Returned if the request was completed successfully.
403 - Forbidden	Returned if you do not have permission to view this script.
404 - NotFound	Returned if no script with that identifier exists.

Example - GET

Retrieves script by its unique identifier.

Request Headers

Key	Value	Description
Accept	application/json

Request Parameters

Key	Value	Description
{id}	4bb709c2-e0e7-4af3-9f60-a045016a9610	The unique identifier (GUID) of the script to retrieve.

Response Headers

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

Response Body

{
  "Id": "4bb709c2-e0e7-4af3-9f60-a045016a9610",
  "Name": "Report pagination",
  "AssignedToId": "191375f2-ae6e-4b52-8bed-4192e34b6486",
  "AssignedTo": "joeb",
  "Description": "Check report pagination works correctly",
  "PriorityId": "fe92720f-3fbd-4e49-a3b2-309f6a0a062a",
  "StatusId": "62daf195-0a65-400f-af4b-7fda3d529acb",
  "TypeId": "cfe51645-8179-4fe5-ada3-c145a64d0a05",
  "CreatedAt": "2012-01-01T14:04:05Z",
  "LastUpdatedAt": "2012-02-02T15:05:06Z",
  "CreatedById": "191375f2-ae6e-4b52-8bed-4192e34b6486",
  "CreatedBy": "joeb",
  "LastUpdatedById": "191375f2-ae6e-4b52-8bed-4192e34b6486",
  "LastUpdatedBy": "joeb",
  "Objective": null,
  "PreCondition": null,
  "PostCondition": null,
  "Number": 1,
  "EstimatedDuration": null,
  "PackageId": "0f2c3a76-bbd1-4370-8faa-6aacb52f1a01",
  "OrderNumber": 0,
  "ProjectId": "27dcaff0-1f8a-4dff-b49a-bb3d9f7153b3",
  "ProjectName": "Test Project",
  "PackageName": "Cycle 1",
  "ChangeComment": null,
  "Notes": null,
  "VersionNumber": 0,
  "HasAttachments": false,
  "Expands": [
    "Widgets",
    "FieldValues",
    "Package",
    "Assignments"
  ],
  "Self": "http://localhost/api/script/4bb709c2-e0e7-4af3-9f60-a045016a9610",
  "Links": [
    {
      "Href": "http://localhost/api/script/4bb709c2-e0e7-4af3-9f60-a045016a9610/relationships",
      "Rel": "Relationships"
    },
    {
      "Href": "http://localhost/api/script/4bb709c2-e0e7-4af3-9f60-a045016a9610/allrelationships",
      "Rel": "AllRelationships"
    },
    {
      "Href": "http://localhost/api/script/4bb709c2-e0e7-4af3-9f60-a045016a9610/assignments",
      "Rel": "Assignments"
    }
  ]
}

Status Code

200 - OK

PATCH

Updates an existing custom field.

Required Permissions

TestManagement/ManageScripts/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).

Status	Description
204 - NoContent	Returned if it updated the script successfully.
403 - Forbidden	Returned if ET would not complete request (normally due to a validation failure or you don't have the necessary permissions to complete the request).
404 - NotFound	Returned if the script does not exist.

PUT

Updates an existing script.

Required Permissions

TestManagement/ManageScripts/Edit

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.
403 - Forbidden	Returned if ET would not complete request (normally due to a validation failure or you don't have the necessary permissions to complete the request).
404 - NotFound	Returned if the script does not exist.

Example - PUT (rename script)

An example of renaming a script.

Request Headers

Key	Value	Description
Accept	application/json
Content-type	application/json

Request Parameters

Key	Value	Description
{id}	4bb709c2-e0e7-4af3-9f60-a045016a9610	The unique identifier (GUID) of the script to update.

Request Body

{ "Name": "Updated name" }

Response Headers

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

Response Body

{
  "Id": "4bb709c2-e0e7-4af3-9f60-a045016a9610",
  "Name": "Updated name",
  "AssignedToId": null,
  "AssignedTo": null,
  "Description": null,
  "PriorityId": "fe92720f-3fbd-4e49-a3b2-309f6a0a062a",
  "StatusId": "62daf195-0a65-400f-af4b-7fda3d529acb",
  "TypeId": "cfe51645-8179-4fe5-ada3-c145a64d0a05",
  "CreatedAt": "2012-01-01T14:04:05Z",
  "LastUpdatedAt": "2012-02-02T15:05:06Z",
  "CreatedById": "191375f2-ae6e-4b52-8bed-4192e34b6486",
  "CreatedBy": "joeb",
  "LastUpdatedById": "191375f2-ae6e-4b52-8bed-4192e34b6486",
  "LastUpdatedBy": "joeb",
  "Objective": null,
  "PreCondition": null,
  "PostCondition": null,
  "Number": 1,
  "EstimatedDuration": null,
  "PackageId": "0f2c3a76-bbd1-4370-8faa-6aacb52f1a01",
  "OrderNumber": 0,
  "ProjectId": "27dcaff0-1f8a-4dff-b49a-bb3d9f7153b3",
  "ProjectName": "Test Project",
  "PackageName": "Cycle 1",
  "ChangeComment": null,
  "Notes": null,
  "VersionNumber": 0,
  "HasAttachments": false,
  "Expands": [
    "Widgets",
    "FieldValues",
    "Package",
    "Assignments"
  ],
  "Self": "http://localhost/api/script/4bb709c2-e0e7-4af3-9f60-a045016a9610",
  "Links": [
    {
      "Href": "http://localhost/api/script/4bb709c2-e0e7-4af3-9f60-a045016a9610/relationships",
      "Rel": "Relationships"
    },
    {
      "Href": "http://localhost/api/script/4bb709c2-e0e7-4af3-9f60-a045016a9610/allrelationships",
      "Rel": "AllRelationships"
    },
    {
      "Href": "http://localhost/api/script/4bb709c2-e0e7-4af3-9f60-a045016a9610/assignments",
      "Rel": "Assignments"
    }
  ]
}

Status Code

200 - OK

Example - PUT (move script to new package)

An example of renaming a script.

Request Headers

Key	Value	Description
Accept	application/json
Content-type	application/json

Request Parameters

Key	Value	Description
{id}	4bb709c2-e0e7-4af3-9f60-a045016a9610	The unique identifier (GUID) of the script to update.

Request Body

{ "PackageId": "daa396d6-ad7d-4acf-a6c5-40551a70f79" }

Response Headers

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

Response Body

{
  "Id": "4bb709c2-e0e7-4af3-9f60-a045016a9610",
  "Name": "Updated name",
  "AssignedToId": null,
  "AssignedTo": null,
  "Description": null,
  "PriorityId": "fe92720f-3fbd-4e49-a3b2-309f6a0a062a",
  "StatusId": "62daf195-0a65-400f-af4b-7fda3d529acb",
  "TypeId": "cfe51645-8179-4fe5-ada3-c145a64d0a05",
  "CreatedAt": "2012-01-01T14:04:05Z",
  "LastUpdatedAt": "2012-02-02T15:05:06Z",
  "CreatedById": "191375f2-ae6e-4b52-8bed-4192e34b6486",
  "CreatedBy": "joeb",
  "LastUpdatedById": "191375f2-ae6e-4b52-8bed-4192e34b6486",
  "LastUpdatedBy": "joeb",
  "Objective": null,
  "PreCondition": null,
  "PostCondition": null,
  "Number": 1,
  "EstimatedDuration": null,
  "PackageId": "daa396d6-ad7d-4acf-a6c5-40551a70f790",
  "OrderNumber": 0,
  "ProjectId": "27dcaff0-1f8a-4dff-b49a-bb3d9f7153b3",
  "ProjectName": "Test Project",
  "PackageName": "Cycle 3",
  "ChangeComment": null,
  "Notes": null,
  "VersionNumber": 0,
  "HasAttachments": false,
  "Expands": [
    "Widgets",
    "FieldValues",
    "Package",
    "Assignments"
  ],
  "Self": "http://localhost/api/script/4bb709c2-e0e7-4af3-9f60-a045016a9610",
  "Links": [
    {
      "Href": "http://localhost/api/script/4bb709c2-e0e7-4af3-9f60-a045016a9610/relationships",
      "Rel": "Relationships"
    },
    {
      "Href": "http://localhost/api/script/4bb709c2-e0e7-4af3-9f60-a045016a9610/allrelationships",
      "Rel": "AllRelationships"
    },
    {
      "Href": "http://localhost/api/script/4bb709c2-e0e7-4af3-9f60-a045016a9610/assignments",
      "Rel": "Assignments"
    }
  ]
}

Status Code

200 - OK

Example - PUT (generate new auto-number)

An example of updating a script with a new automatically generated value (if auto-number of scripts is enabled for the project this script belongs to).

Request Headers

Key	Value	Description
Accept	application/json
Content-type	application/json

Request Parameters

Key	Value	Description
{id}	4bb709c2-e0e7-4af3-9f60-a045016a9610	The unique identifier (GUID) of the script to update.

Request Body

{ "Number": "auto" }

Response Headers

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

Response Body

{
  "Id": "4bb709c2-e0e7-4af3-9f60-a045016a9610",
  "Name": "Sample name",
  "AssignedToId": null,
  "AssignedTo": null,
  "Description": null,
  "PriorityId": "fe92720f-3fbd-4e49-a3b2-309f6a0a062a",
  "StatusId": "62daf195-0a65-400f-af4b-7fda3d529acb",
  "TypeId": "cfe51645-8179-4fe5-ada3-c145a64d0a05",
  "CreatedAt": "2012-01-01T14:04:05Z",
  "LastUpdatedAt": "2012-02-02T15:05:06Z",
  "CreatedById": "191375f2-ae6e-4b52-8bed-4192e34b6486",
  "CreatedBy": "joeb",
  "LastUpdatedById": "191375f2-ae6e-4b52-8bed-4192e34b6486",
  "LastUpdatedBy": "joeb",
  "Objective": null,
  "PreCondition": null,
  "PostCondition": null,
  "Number": 1234,
  "EstimatedDuration": null,
  "PackageId": "0f2c3a76-bbd1-4370-8faa-6aacb52f1a01",
  "OrderNumber": 0,
  "ProjectId": "27dcaff0-1f8a-4dff-b49a-bb3d9f7153b3",
  "ProjectName": "Test Project",
  "PackageName": "Cycle 1",
  "ChangeComment": null,
  "Notes": null,
  "VersionNumber": 0,
  "HasAttachments": false,
  "Expands": [
    "Widgets",
    "FieldValues",
    "Package",
    "Assignments"
  ],
  "Self": "http://localhost/api/script/4bb709c2-e0e7-4af3-9f60-a045016a9610",
  "Links": [
    {
      "Href": "http://localhost/api/script/4bb709c2-e0e7-4af3-9f60-a045016a9610/relationships",
      "Rel": "Relationships"
    },
    {
      "Href": "http://localhost/api/script/4bb709c2-e0e7-4af3-9f60-a045016a9610/allrelationships",
      "Rel": "AllRelationships"
    },
    {
      "Href": "http://localhost/api/script/4bb709c2-e0e7-4af3-9f60-a045016a9610/assignments",
      "Rel": "Assignments"
    }
  ]
}

Status Code

200 - OK

Example - PUT (full update)

An example of updating an existing script with most fields populated (including custom fields).

Request Headers

Key	Value	Description
Accept	application/json
Content-type	application/json

Request Parameters

Key	Value	Description
{id}	4bb709c2-e0e7-4af3-9f60-a045016a9610	The unique identifier (GUID) of the script to update.
$expand	FieldValues	Expand field (we expand the FieldValues to ensure we get it back in the response to creating a new script.

Request Body

{
  "Id": "4bb709c2-e0e7-4af3-9f60-a045016a9610",
  "TemporaryId": "6cc26034-6514-44e0-907c-8f4f5eaa85b5",
  "PackageId": "0f2c3a76-bbd1-4370-8faa-6aacb52f1a01",
  "Number": 1234,
  "Name": "Report pagination",
  "AssignedToId": "191375f2-ae6e-4b52-8bed-4192e34b6486",
  "EstimatedDuration": "5m",
  "PriorityId": "fe92720f-3fbd-4e49-a3b2-309f6a0a062a",
  "StatusId": "62daf195-0a65-400f-af4b-7fda3d529acb",
  "TypeId": "cfe51645-8179-4fe5-ada3-c145a64d0a05",
  "Description": "description",
  "Objective": "objective",
  "PostCondition": "post condition",
  "PreCondition": "pre condition",
  "Notes": "notes",
  "Steps": [
    {
      "Description": "Do this",
      "ExpectedResult": "Expect that",
      "Notes": "some notes",
      "Data": "Some data",
      "OrderNumber": 0
    },
    {
      "Description": "Then Do this",
      "ExpectedResult": "and expect that",
      "Notes": "some more notes",
      "Data": "Some more data",
      "OrderNumber": 1
    }
  ],
  "ChangeComment": "Script created updated via my API",
  "OrderNumber": 2,
  "WidgetValues": null,
  "FieldValues": {
    "Cycle": "V2.1 Cycle 1"
  }
}

Response Headers

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

Response Body

{
  "Id": "4bb709c2-e0e7-4af3-9f60-a045016a9610",
  "Name": "My New Script",
  "AssignedToId": "191375f2-ae6e-4b52-8bed-4192e34b6486",
  "AssignedTo": "joeb",
  "Description": "description",
  "PriorityId": "fe92720f-3fbd-4e49-a3b2-309f6a0a062a",
  "StatusId": "62daf195-0a65-400f-af4b-7fda3d529acb",
  "TypeId": "cfe51645-8179-4fe5-ada3-c145a64d0a05",
  "CreatedAt": "2012-01-01T14:04:05Z",
  "LastUpdatedAt": "2012-02-02T15:05:06Z",
  "CreatedById": "191375f2-ae6e-4b52-8bed-4192e34b6486",
  "CreatedBy": "joeb",
  "LastUpdatedById": "191375f2-ae6e-4b52-8bed-4192e34b6486",
  "LastUpdatedBy": "joeb",
  "Objective": "objective",
  "PreCondition": "pre condition",
  "PostCondition": "post condition",
  "Number": 1,
  "EstimatedDuration": "5 minutes",
  "PackageId": "0f2c3a76-bbd1-4370-8faa-6aacb52f1a01",
  "OrderNumber": 22,
  "ProjectId": "27dcaff0-1f8a-4dff-b49a-bb3d9f7153b3",
  "ProjectName": "Test Project",
  "PackageName": "Cycle 1",
  "ChangeComment": "Script created updated via my API",
  "Notes": "notes",
  "VersionNumber": 2,
  "HasAttachments": true,
  "Expands": [
    "Widgets",
    "FieldValues",
    "Package",
    "Assignments"
  ],
  "Self": "http://localhost/api/script/4bb709c2-e0e7-4af3-9f60-a045016a9610",
  "Links": [
    {
      "Href": "http://localhost/api/script/4bb709c2-e0e7-4af3-9f60-a045016a9610/relationships",
      "Rel": "Relationships"
    },
    {
      "Href": "http://localhost/api/script/4bb709c2-e0e7-4af3-9f60-a045016a9610/allrelationships",
      "Rel": "AllRelationships"
    },
    {
      "Href": "http://localhost/api/script/4bb709c2-e0e7-4af3-9f60-a045016a9610/assignments",
      "Rel": "Assignments"
    }
  ]
}

Status Code

200 - OK

Resources / Script

Resource: Script ( /api/script/{id} )

Methods

DELETE

Required Permissions

Status Codes

GET

Required Permissions

Supported Expansions

Status Codes

PATCH

Required Permissions

Status Codes

PUT

Required Permissions

Supported Expansions

Status Codes