Skip to content

Function: getAttachmentVersions()

ts
function getAttachmentVersions(client, parameters): Promise<{
[key: string]: unknown;
  _links?: {
   [key: string]: unknown;
     base?: string;
     byOperation?: string;
     collection?: string;
     context?: string;
     download?: string;
     editui?: string;
     edituiv2?: string;
     next?: string;
     prev?: string;
     self?: string;
     tinyui?: string;
     webui?: string;
  };
  results?: object[];
}>;

Defined in: src/v2/api/version.ts:28

Returns the versions of specific attachment.

Permissions required: Permission to view the attachment and its corresponding space.

Parameters

ParameterTypeDescription
clientClient-
parameters{ cursor?: string; id: string; limit?: number; sort?: "modified-date" | "-modified-date"; }-
parameters.cursor?stringUsed for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.
parameters.idstringThe ID of the attachment to be queried for its versions. If you don't know the attachment ID, use Get attachments and filter the results.
parameters.limit?numberMaximum number of versions per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.
parameters.sort?"modified-date" | "-modified-date"Used to sort the result by a particular field.

Returns

Promise&lt;{ [key: string]: unknown; _links?: { [key: string]: unknown; base?: string; byOperation?: string; collection?: string; context?: string; download?: string; editui?: string; edituiv2?: string; next?: string; prev?: string; self?: string; tinyui?: string; webui?: string; }; results?: object[]; }>