Resource: Requirement Attachments ( /api/requirement/{id}/attachments )
Requirement Attachments (collection) resource for fetching attachments associated with a requirement, or adding new attachments to the requirement.
This resource supports the following methods: GET, POST
Methods
GET
Retrieves list of attachments for the requirement.
This method supports the OData parameters $filter, $top, $take, $orderby and $inlinecount. See OData Topic for more details.
Required Permissions
- TestManagement/View
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 have insufficient permissions to retrieve attachments. |
| 404 - NotFound | Returned if the requirement was not found. |
Retrieves a list of all attachments associated with a requirement.
Request Headers
| Key | Value | Description |
|---|---|---|
| Accept | application/json |
Request Parameters
| Key | Value | Description |
|---|---|---|
| {id} | 4bb709c2-e0e7-4af3-9f60-a045016a9610 | Unique identifier of the script. |
Response Headers
| Key | Value | Description |
|---|---|---|
| Content-Type | application/json; charset=utf-8 |
Response Body
| Code Block | ||
|---|---|---|
| ||
{
"Items": [
{
"Id": "9b02c840-c330-4725-b743-b40181420bc2",
"RequirementId": "ad506e26-dea1-4fba-a2c8-ee993b9f9444",
"Name": "screenshot 1",
"FileName": "screenshot1.png",
"ContentType": "image/png",
"CreatedAt": "2012-01-01T14:04:05Z",
"CreatedById": "2b364daa-0dff-4a6f-8554-f5963d3011be",
"Size": 122454,
"Self": "http://localhost/api/requirement/ad506e26-dea1-4fba-a2c8-ee993b9f9444/attachment/9b02c840-c330-4725-b743-b40181420bc2",
"Content": "http://localhost/api/attachment/00000000-0000-0000-0000-000000000000/contents"
},
{
"Id": "5669f517-5ef4-40b6-856f-dbd488319da6",
"RequirementId": "ad506e26-dea1-4fba-a2c8-ee993b9f9444",
"Name": "notes.txt",
"FileName": "notes",
"ContentType": "text/plain",
"CreatedAt": "2012-01-01T14:04:05Z",
"CreatedById": "2b364daa-0dff-4a6f-8554-f5963d3011be",
"Size": 3,
"Self": "http://localhost/api/requirement/ad506e26-dea1-4fba-a2c8-ee993b9f9444/attachment/5669f517-5ef4-40b6-856f-dbd488319da6",
"Content": "http://localhost/api/attachment/00000000-0000-0000-0000-000000000000/contents"
}
]
}
|
Status Code
200 - OK
POST
Upload one or more attachments for this requirement.
Required Permissions
- TestManagement/ManageRequirements
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 attachments were uploaded successfully. |
| 403 - Forbidden | Returned if the multipart request did not contain any files. |
| 415 - UnsupportedMediaType | Returned if the request is not mime multipart. |
Uploads one or more files using a mime multipart request (this example shows a response where two files were uploaded).
Request Headers
| Key | Value | Description |
|---|---|---|
| Content-Type | multipart/mixed; boundary=65bf6b94-c91c-442c-abe7-f41444d7c71f |
Request Parameters
| Key | Value | Description |
|---|---|---|
| {id} | 4bb709c2-e0e7-4af3-9f60-a045016a9610 | The unique identifier (GUID) of the script to add the attachments to. |
Request Body
| Code Block | ||
|---|---|---|
| ||
--65bf6b94-c91c-442c-abe7-f41444d7c71f Content-Disposition: attachment; filename=screenshot1.png; name="screenshot 1"; size=122454 Content-Type: image/png Content-Length: 3 ... --65bf6b94-c91c-442c-abe7-f41444d7c71f Content-Disposition: attachment; filename=notes.txt; name=notes; size=3 Content-Type: text/plain Content-Length: 3 ABC --65bf6b94-c91c-442c-abe7-f41444d7c71f-- |
Response Headers
| Key | Value | Description |
|---|---|---|
| Content-Type | application/json; charset=utf-8 |
Response Body
| Code Block | ||
|---|---|---|
| ||
{
"Items": [
{
"Id": "9b02c840-c330-4725-b743-b40181420bc2",
"RequirementId": "ad506e26-dea1-4fba-a2c8-ee993b9f9444",
"Name": "screenshot 1",
"FileName": "screenshot1.png",
"ContentType": "image/png",
"CreatedAt": "2012-01-01T14:04:05Z",
"CreatedById": "2b364daa-0dff-4a6f-8554-f5963d3011be",
"Size": 122454,
"Self": "http://localhost/api/requirement/ad506e26-dea1-4fba-a2c8-ee993b9f9444/attachment/9b02c840-c330-4725-b743-b40181420bc2",
"Content": "http://localhost/api/attachment/00000000-0000-0000-0000-000000000000/contents"
},
{
"Id": "5669f517-5ef4-40b6-856f-dbd488319da6",
"RequirementId": "ad506e26-dea1-4fba-a2c8-ee993b9f9444",
"Name": "notes.txt",
"FileName": "notes",
"ContentType": "text/plain",
"CreatedAt": "2012-01-01T14:04:05Z",
"CreatedById": "2b364daa-0dff-4a6f-8554-f5963d3011be",
"Size": 3,
"Self": "http://localhost/api/requirement/ad506e26-dea1-4fba-a2c8-ee993b9f9444/attachment/5669f517-5ef4-40b6-856f-dbd488319da6",
"Content": "http://localhost/api/attachment/00000000-0000-0000-0000-000000000000/contents"
}
]
}
|
Status Code
201 - Created