Skip to content

Function: getPageVersions()

ts
function getPageVersions(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:74

Returns the versions of specific page.

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

Parameters

ParameterTypeDescription
clientClient-
parameters{ bodyFormat?: "storage" | "atlas_doc_format"; cursor?: string; id: number; limit?: number; sort?: "modified-date" | "-modified-date"; }-
parameters.bodyFormat?"storage" | "atlas_doc_format"The content format types to be returned in the body field of the response. If available, the representation will be available under a response field of the same name under the body field.
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.idnumberThe ID of the page to be queried for its versions. If you don't know the page ID, use Get pages 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[]; }>