Resource: Script Package ( /api/scriptpackage/{id} )
Script Package resource
This resource supports the following methods: DELETE, GET, PUT
Methods
DELETE
Deletes a script package by its unique identifier.
Required Permissions
- TestManagement/ManageScripts
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 script package was deleted successfully. |
| 403 - Forbidden | Returned if script package can not be deleted (normally because you don't have permission, or the package has children but you did not pass the deleteChildren parameter). |
| 404 - NotFound | Returned if the script package was not found. |
An example of deleting an package
Request Parameters
| Key | Value | Description |
|---|---|---|
| {id} | 4bb709c2-e0e7-4af3-9f60-a045016a9610 | The GUID Identifier of package to delete. |
Status Code
200 - OK
An example of deleting an package with children.
Request Parameters
| Key | Value | Description |
|---|---|---|
| {id} | 4bb709c2-e0e7-4af3-9f60-a045016a9610 | The GUID Identifier of package to delete. |
| deleteChildren | true | Will delete a package and all its children. |
Status Code
200 - OK
An example of deleting a non-empty package without deleteChildren=true.
Request Parameters
| Key | Value | Description |
|---|---|---|
| {id} | 4bb709c2-e0e7-4af3-9f60-a045016a9610 | The GUID Identifier of package to delete |
Response Body
{
"Message": "The package is not empty."
}
Status Code
403 - Forbidden
GET
Retrieves a script package by its unique identifier.
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. |
An example of retrieving a package by its unique identifier.
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 retrieve. |
Response Headers
| Key | Value | Description |
|---|---|---|
| Content-Type | application/json; charset=utf-8 |
Response Body
{
"Id": "4bb709c2-e0e7-4af3-9f60-a045016a9610",
"ParentId": "cc91ec0b-a9f2-44fe-bf86-97ecb98cecc6",
"Name": "New Package Name",
"OrderNumber": 1,
"Expands": [
"Children",
"Parent",
"Project"
],
"Self": "http://localhost/api/scriptpackage/4bb709c2-e0e7-4af3-9f60-a045016a9610",
"Links": [
{
"Href": "http://localhost/api/scriptpackage/4bb709c2-e0e7-4af3-9f60-a045016a9610/children",
"Rel": "Children"
},
{
"Href": "http://localhost/api/scriptpackage/cc91ec0b-a9f2-44fe-bf86-97ecb98cecc6",
"Rel": "Parent"
}
]
}
Status Code
200 - OK
PUT
Update a script package.
Required Permissions
- TestManagement/ManageScripts
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 the user does not have permission to create script packages in the target project. |
| 404 - NotFound | Returned if the package does not exist. |
Updating a package's name.
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 update. |
Request Body
{
"Id": "4bb709c2-e0e7-4af3-9f60-a045016a9610",
"Name": "New Package Name"
}
Response Headers
| Key | Value | Description |
|---|---|---|
| Content-Type | application/json; charset=utf-8 |
Response Body
{
"Id": "4bb709c2-e0e7-4af3-9f60-a045016a9610",
"ProjectId": "944aa658-8067-42cf-a6a6-ce71535a73bc",
"Name": "New Package Name",
"OrderNumber": 1,
"Expands": [
"Children",
"Parent",
"Project"
],
"Self": "http://localhost/api/scriptpackage/4bb709c2-e0e7-4af3-9f60-a045016a9610",
"Links": [
{
"Href": "http://localhost/api/scriptpackage/4bb709c2-e0e7-4af3-9f60-a045016a9610/children",
"Rel": "Children"
},
{
"Href": "http://localhost/api/project/944aa658-8067-42cf-a6a6-ce71535a73bc",
"Rel": "Project"
}
]
}
Status Code
200 - OK
Updating a package to have a different parent.
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 update. |
Request Body
{
"Id": "4bb709c2-e0e7-4af3-9f60-a045016a9610",
"ParentId": "cc91ec0b-a9f2-44fe-bf86-97ecb98cecc6"
}
Response Headers
| Key | Value | Description |
|---|---|---|
| Content-Type | application/json; charset=utf-8 |
Response Body
{
"Id": "4bb709c2-e0e7-4af3-9f60-a045016a9610",
"ParentId": "cc91ec0b-a9f2-44fe-bf86-97ecb98cecc6",
"Name": "New Package Name",
"OrderNumber": 1,
"Expands": [
"Children",
"Parent",
"Project"
],
"Self": "http://localhost/api/scriptpackage/4bb709c2-e0e7-4af3-9f60-a045016a9610",
"Links": [
{
"Href": "http://localhost/api/scriptpackage/4bb709c2-e0e7-4af3-9f60-a045016a9610/children",
"Rel": "Children"
},
{
"Href": "http://localhost/api/scriptpackage/cc91ec0b-a9f2-44fe-bf86-97ecb98cecc6",
"Rel": "Parent"
}
]
}
Status Code
200 - OK
Updating package name, stereotype, order and parent.
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 update. |
Request Body
{
"Id": "4bb709c2-e0e7-4af3-9f60-a045016a9610",
"Name": "New Package Name",
"OrderNumber": 2,
"ParentId": "cc91ec0b-a9f2-44fe-bf86-97ecb98cecc6"
}
Response Headers
| Key | Value | Description |
|---|---|---|
| Content-Type | application/json; charset=utf-8 |
Response Body
{
"Id": "4bb709c2-e0e7-4af3-9f60-a045016a9610",
"ParentId": "cc91ec0b-a9f2-44fe-bf86-97ecb98cecc6",
"Name": "New Package Name",
"OrderNumber": 2,
"Expands": [
"Children",
"Parent",
"Project"
],
"Self": "http://localhost/api/scriptpackage/4bb709c2-e0e7-4af3-9f60-a045016a9610",
"Links": [
{
"Href": "http://localhost/api/scriptpackage/4bb709c2-e0e7-4af3-9f60-a045016a9610/children",
"Rel": "Children"
},
{
"Href": "http://localhost/api/scriptpackage/cc91ec0b-a9f2-44fe-bf86-97ecb98cecc6",
"Rel": "Parent"
}
]
}
Status Code
200 - OK