Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface GetWorkspaceParams

Parameters for the getWorkspace operation.

Hierarchy

  • GetWorkspaceParams

Index

Properties

Properties

Optional _export

_export: boolean

Whether to include all element content in the returned data. If export=false, the returned data includes only information about the element itself. If export=true, all content, including subelements, is included.

Optional headers

headers: OutgoingHttpHeaders

Optional includeAudit

includeAudit: boolean

Whether to include the audit properties (created and updated timestamps) in the response.

Optional sort

sort: Sort | string

Indicates how the returned workspace data will be sorted. This parameter is valid only if export=true. Specify sort=stable to sort all workspace objects by unique identifier, in ascending alphabetical order.

workspaceId

workspaceId: string

Unique identifier of the workspace.

Generated using TypeDoc