# Get Twin Doc
This endpoint retrieves the details od the given Doc. You can include the optional query string parameter
"download" in the request to generate a temporary download URL to download the Doc in
The download URL is temporary and expires after 60 minutes. After the URL has expired, you will need to generate a new download URL. After the download URL has been generated, you need to send a GET request to that URL to download the given Doc.
In order for a user to perform the "get_twin_doc" operation, the "get_twin_doc" permission must be included in the list of allowed actions in the statement of the user's role.
|string||path||Name of the Doc. It must match the regular expression(opens new window) |
|boolean, ||query string||Denotes whether to return a download URL or not. The download URL is a temporary URL allowing to download a copy of the Doc.|
|timestamp||query string||Time at which the download URL expires. Measured in seconds (to three decimal places) that have elapsed since the Unix epoch(opens new window). If not provided, the download URL expires 60 minutes after it has been generated.|
"download" parameter is optional and does not need to be included in the request. If it is not included, its default value is used.
"validity_ts" parameter is optional and does not need to be included in the request. If it is not included in the request, but the
download parameter is set to
True, the download URL expires 60 minutes after it has been generated.
Certificate generated automatically by the system upon sending a request to copy the Doc (attach_twin_doc endpoint). It cannot be modified after it has been generated.
|storage_class||string, value can be ||Storage class of the Doc:|
Once the Doc has been copied and attached to a Twin, the
|status||string, value can be ||Status of the Doc:|
|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).|
|description||dictionary||User-defined key-value pairs:|
- key: It must match the regular expression(opens new window)
- value: JSON compliant value.
For more details consult the description field section.
Holds the temporary download URL and the validity of the download URL.
"hash" attribute is only displayed in the
"creation_certificate" if it was provided in the request to attach the Doc to the given Twin attach_twin_doc endpoint.
# GET request
In order to access the Doc, you need to download it by sending a GET request to the download URL.
# Status codes
Requests to this endpoint result in generic status codes. For a comprehensive list of status codes, please consult the Status codes section.