Get Twin

This endpoint retrieves the details of a given Twin.

By default, terminated Twins are included in search results. To only search for "alive" Twins, include the query string parameter "show_terminated" with the value False in the request.

Method	Path	Operation*
GET	/twins/{twin}	get_twin

*

In order for a user to perform the "get_twin" operation, the "get_twin" 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 of the Twin to be retrieved.
show_terminated optional *	boolean, DEFAULT=True	query string	Determines whether terminated Twins are included in the search results.

*

The "show_terminated" parameter is optional and does not need to be included in the query string of the request. If it is not included in the request, its default value is used.

Response

Attribute	Type	Description
owner	string	Account UUID of the account which is the current owner of the Twin. The ownership of a Twin can be transferred.
status	string, value is "alive" or "terminated"	The status of a Twin can be "alive" or "terminated". In case of alive Twins, the "description" can be updated by the owner of the Twin. In case of terminated Twins, the description field cannot be updated. Ledger Entries, Identities, and Docs can be attached to alive and terminated Twins by all users involved in the process.
updated_ts	timestamp	Time at which the Twin was last updated. Measured in seconds (to three decimal places) that have elapsed since the Unix epoch(opens new window).
description	dictionary	Attributes of the Twin defined by the owner in form of key-value pairs: - key: It must match the regular expression(opens new window) ^[a-z_][0-9a-z_]{0,63}$. - value: JSON compliant value. Only the owner of the Twin can update the description of the Twin. For more details consult the description field section.
creation_certificate	dictionary	Certificate generated automatically by the system upon creation of a Twin. It cannot be modified after it has been generated. Attribute Type Description uuid string Twin UUID. It is generated automatically when a Twin is created and stored in the "uuid" field of the creation certificate. creator string Account UUID of the account creating the Twin. created_ts timestamp Time at which the Twin was created. Measured in seconds (to three decimal places) that have elapsed since the Unix epoch(opens new window).
termination_certificate	dictionary	Certificate generated automatically by the system when a Twin is terminated. It cannot be modified after it has been generated. Attribute Type Description issuer string Account UUID of the account terminating the Twin. terminated_ts timestamp Time at which the Twin was terminated. Measured in seconds (to three decimal places) that have elapsed since the Unix epoch(opens new window).

Status codes

Requests to this endpoint result in generic status codes. For a comprehensive list of status codes, please consult the Status codes section.