Date: Fri, 29 Mar 2024 16:02:54 +0000 (UTC) Message-ID: <136959397.12797.1711728174434@catch-kbase-p> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_12796_921506179.1711728174433" ------=_Part_12796_921506179.1711728174433 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html
Script Assignment resource
This resource supports the following methods: DELETE, GET, PUT= a>
Deletes a single script assignment by its unique identifier.
These are the expected status codes returned by the service. In addition= , some other status codes may be returned if either an internal error occur= s or there is an authentication issue (such as an expired OAuth token).
Status | Description |
---|---|
200 - OK | Returned if the request was completed successful= ly. |
403 - Forbidden | Returned if you do not have permission to delete= this script assignment. |
404 - NotFound | Returned if no script assignment with that ident= ifier exists. |
An Example of deleting a script assignment.
Request Headers
Key | Value | Description |
---|---|---|
Accept | application/json |
Request Parameters
Key | Value | Description |
---|---|---|
{id} | 4bb709c2-e0e7-4af3-9f60-a045016a9610 | The GUID Identifier of the script assignment to = delete. |
Response Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json; charset=3Dutf-8 |
Status Code
200 - OK
Retrieves a single script assignment by its unique identifier.
For more details on expansions, please see the Expand help topic.
These are the expected status codes returned by the service. In addition= , some other status codes may be returned if either an internal error occur= s or there is an authentication issue (such as an expired OAuth token).
Status | Description |
---|---|
200 - OK | Returned if the request was completed successful= ly. |
403 - Forbidden | Returned if you do not have permission to view t= his script assignment. |
404 - NotFound | Returned if no script assignment with that ident= ifier exists. |
An example of retrieving a script assignment.
Request Headers
Key | Value | Description |
---|---|---|
Accept | application/json |
Request Parameters
Key | Value | Description |
---|---|---|
{id} | 4bb709c2-e0e7-4af3-9f60-a045016a9610 | The GUID Identifier of assignment to retrieve.= td> |
Response Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json; charset=3Dutf-8 |
Response Body
{ "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-a0= 45016a9610", "Links": [ { "Href": "http://localhost/api/scriptassignment/4bb709c2-e0e7-4af3-9f6= 0-a045016a9610/allrelationships", "Rel": "AllRelationships" }, { "Href": "http://localhost/api/executionpackage/f6ed1282-bd89-4f8f-8e9= 4-47e344bba905", "Rel": "ExecutionPackage" }, { "Href": "http://localhost/api/scriptassignment/4bb709c2-e0e7-4af3-9f6= 0-a045016a9610/relationships", "Rel": "Relationships" }, { "Href": "http://localhost/api/scriptassignment/4bb709c2-e0e7-4af3-9f6= 0-a045016a9610/runs", "Rel": "Runs" }, { "Href": "http://localhost/api/script/5ef6c545-6ef8-472e-bae7-b1cc3d3f= bab0", "Rel": "Script" } ] }
Status Code
200 - OK
Update script assignment
For more details on expansions, please see the Expand help topic.
These are the expected status codes returned by the service. In addition= , some other status codes may be returned if either an internal error occur= s or there is an authentication issue (such as an expired OAuth token).
Status | Description |
---|---|
200 - OK | Returned if the script assignment was updated su= ccessfully. |
403 - Forbidden | Returned if the request could not be completed s= uccessfuly (normally due to lack of permissions or validation failure). |
Updating the package which the script assignment belongs to.
Request Headers
Key | Value | Description |
---|---|---|
Accept | application/json |
Request Parameters
Key | Value | Description |
---|---|---|
{id} | 4bb709c2-e0e7-4af3-9f60-a045016a9610 | The GUID Identifier of package to delete. |
Request Body
{ "Id": "4bb709c2-e0e7-4af3-9f60-a045016a9610", "PackageId": "f6ed1282-bd89-4f8f-8e94-47e344bba905", "ScriptId": "888f8e22-0137-440a-bcf2-173b9d6f543f" }
Response Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json; charset=3Dutf-8 |
Response Body
{ "Id": "4bb709c2-e0e7-4af3-9f60-a045016a9610", "ScriptId": "888f8e22-0137-440a-bcf2-173b9d6f543f", "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-a0= 45016a9610", "Links": [ { "Href": "http://localhost/api/scriptassignment/4bb709c2-e0e7-4af3-9f6= 0-a045016a9610/allrelationships", "Rel": "AllRelationships" }, { "Href": "http://localhost/api/executionpackage/f6ed1282-bd89-4f8f-8e9= 4-47e344bba905", "Rel": "ExecutionPackage" }, { "Href": "http://localhost/api/scriptassignment/4bb709c2-e0e7-4af3-9f6= 0-a045016a9610/relationships", "Rel": "Relationships" }, { "Href": "http://localhost/api/scriptassignment/4bb709c2-e0e7-4af3-9f6= 0-a045016a9610/runs", "Rel": "Runs" }, { "Href": "http://localhost/api/script/888f8e22-0137-440a-bcf2-173b9d6f= 543f", "Rel": "Script" } ] }
Status Code
200 - OK
Updating a script assignment to be assigned to a new user (this does not= change the tester for any active script runs associated with this assignme= nt).
Request Headers
Key | Value | Description |
---|---|---|
Accept | application/json |
Request Parameters
Key | Value | Description |
---|---|---|
{id} | 4bb709c2-e0e7-4af3-9f60-a045016a9610 | The GUID Identifier of package to delete |
Request Body
{ "Id": "4bb709c2-e0e7-4af3-9f60-a045016a9610", "PackageId": "f6ed1282-bd89-4f8f-8e94-47e344bba905", "AssignedToId": "203f8f8a-20a7-40ff-bb9c-dbed4fcfcd98", "ScriptId": "888f8e22-0137-440a-bcf2-173b9d6f543f" }
Response Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json; charset=3Dutf-8 |
Response Body
{ "Id": "4bb709c2-e0e7-4af3-9f60-a045016a9610", "ScriptId": "888f8e22-0137-440a-bcf2-173b9d6f543f", "Name": "My Script", "Status": "Not Run", "AssignedTo": "joeb", "AssignedToId": "203f8f8a-20a7-40ff-bb9c-dbed4fcfcd98", "PackageId": "f6ed1282-bd89-4f8f-8e94-47e344bba905", "Expands": [ "Package" ], "Self": "http://localhost/api/scriptassignment/4bb709c2-e0e7-4af3-9f60-a0= 45016a9610", "Links": [ { "Href": "http://localhost/api/scriptassignment/4bb709c2-e0e7-4af3-9f6= 0-a045016a9610/allrelationships", "Rel": "AllRelationships" }, { "Href": "http://localhost/api/executionpackage/f6ed1282-bd89-4f8f-8e9= 4-47e344bba905", "Rel": "ExecutionPackage" }, { "Href": "http://localhost/api/scriptassignment/4bb709c2-e0e7-4af3-9f6= 0-a045016a9610/relationships", "Rel": "Relationships" }, { "Href": "http://localhost/api/scriptassignment/4bb709c2-e0e7-4af3-9f6= 0-a045016a9610/runs", "Rel": "Runs" }, { "Href": "http://localhost/api/script/888f8e22-0137-440a-bcf2-173b9d6f= 543f", "Rel": "Script" } ] }
Status Code
200 - OK
Updating a script assignment to be unassigned (a null value cannot be pa= ssed because this will be ignored, due the implementation of partial update= s so an empty GUID is passed instead).
Request Headers
Key | Value | Description |
---|---|---|
Accept | application/json |
Request Parameters
Key | Value | Description |
---|---|---|
{id} | 4bb709c2-e0e7-4af3-9f60-a045016a9610 | The GUID Identifier of the package to delete. |
Request Body
{ "Id": "4bb709c2-e0e7-4af3-9f60-a045016a9610", "PackageId": "f6ed1282-bd89-4f8f-8e94-47e344bba905", "AssignedToId": "00000000-0000-0000-0000-000000000000", "ScriptId": "888f8e22-0137-440a-bcf2-173b9d6f543f" }
Response Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json; charset=3Dutf-8 |
Response Body
{ "Id": "4bb709c2-e0e7-4af3-9f60-a045016a9610", "ScriptId": "888f8e22-0137-440a-bcf2-173b9d6f543f", "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-a0= 45016a9610", "Links": [ { "Href": "http://localhost/api/scriptassignment/4bb709c2-e0e7-4af3-9f6= 0-a045016a9610/allrelationships", "Rel": "AllRelationships" }, { "Href": "http://localhost/api/executionpackage/f6ed1282-bd89-4f8f-8e9= 4-47e344bba905", "Rel": "ExecutionPackage" }, { "Href": "http://localhost/api/scriptassignment/4bb709c2-e0e7-4af3-9f6= 0-a045016a9610/relationships", "Rel": "Relationships" }, { "Href": "http://localhost/api/scriptassignment/4bb709c2-e0e7-4af3-9f6= 0-a045016a9610/runs", "Rel": "Runs" }, { "Href": "http://localhost/api/script/888f8e22-0137-440a-bcf2-173b9d6f= 543f", "Rel": "Script" } ] }
Status Code
200 - OK