# Delete Twin Docs
This endpoint deletes all Docs attached to the given Twin.
Method | Path | Operation* |
---|---|---|
DELETE | /twins/{twin}/docs | delete_twin_docs |
*
In order for a user to perform the "delete_twin_docs" operation, the "delete_twin_docs" permission must be included in the list of allowed actions in the statement of the user's role.
# Request
Parameter | Type | In | Description |
---|---|---|---|
{twin} required | string | path | Twin UUID. |
view optional * | string, value is tree or list , DEFAULT=list | query string | Allows choosing between a tree and a list view. |
*
The "view"
parameter is optional and does not need to be included in the request body. If it is not included in the request, its default value is used.
# Response
The response returns a list of deleted Docs that were attached to the given Twin.
Attribute | Type | Description |
---|---|---|
created_ts | timestamp | Time at which the Doc was attached to the Twin. Measured in seconds (to three decimal places) that have elapsed since the Unix epoch(opens new window). |
updated_ts | timestamp | Time at which the Doc was last updated. Measured in seconds (to three decimal places) that have elapsed since the Unix epoch(opens new window). |
size | integer | Size of the Doc in bytes. |
# Status codes
Requests to this endpoint result in generic status codes. For a comprehensive list of status codes, please consult the Status codes section.
Was this article helpful?