Attachments Swagger API

GET /archivist/v1/attachments/{uuid}

Get an attachment

Returns the attachment associated with the relative resource name

Parameters

  • uuid (string) – Specify the Attachment UUID where attachments/{uuid} is the Attachment Identity e.g. add30235-1424-4fda-840a-d5ef82c4c96f from Identity attachments/add30235-1424-4fda-840a-d5ef82c4c96f

Status Codes

  • 200 OK – A successful response.(streaming responses)

  • 401 Unauthorized – Returned when the user is not authenticated to the system.

  • 403 Forbidden – Returned when the user is not authorized to read the attachment.

  • 404 Not Found – Returned when an attachment with the identity does not exist.

  • 429 Too Many Requests – Returned when a user exceeds their subscription’s rate limit for requests.

  • default – An unexpected error response.

Response JSON Object

  • error.code (integer) –

  • error.details[].@type (string) – A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one “/” character. The last segment of the URL’s path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading “.” is not accepted). In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows: * If no scheme is provided, https is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.

  • error.message (string) –

  • result.content_type (string) – The HTTP Content-Type string representing the content type of the body.

  • result.data (string) – HTTP body binary data.

  • result.extensions[].@type (string) – A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one “/” character. The last segment of the URL’s path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading “.” is not accepted). In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows: * If no scheme is provided, https is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.

GET /archivist/v1/attachments/{uuid}/info

Get attachment metadata

Gets the metadata associated an attachment uuid

Parameters

  • uuid (string) – Specify the Attachment UUID where attachments/{uuid} is the Attachment Identity e.g. add30235-1424-4fda-840a-d5ef82c4c96f from Identity attachments/add30235-1424-4fda-840a-d5ef82c4c96f

Status Codes

  • 200 OK – A successful response.

  • 401 Unauthorized – Returned when the user is not authenticated to the system.

  • 403 Forbidden – Returned when the user is not authorized to read the attachment.

  • 404 Not Found – Returned when an attachment with the identity does not exist.

  • 429 Too Many Requests – Returned when a user exceeds their subscription’s rate limit for requests.

  • default – An unexpected error response.

Response JSON Object

  • hash.alg (string) –

  • hash.value (string) – Calculated hash.

  • identity (string) – Relative resource name for the attachment. e.g. attachments/20c97f42-87fc-482c-9d58-4d11abd33359 (read only)

  • mime_type (string) – Type of data e.g. image/jpeg (read only)

  • size (string) – Size of blob in bytes (read only)

  • timestamp_accepted (string) – Timestamp of creation (read only)