Interface: ConvenienceApi

ConvenienceApi.ConvenienceApi

Description

Provides basic properties of the current list page and any tools that need to be shared with the script

Properties

Properties

activeObjectTypeProperties

Description

Contains an API to retrieve additional info about the object that the list is being displayed for

artifactID

  • artifactID: undefined | number

Description

The ID used to identify the workspace or system root ID (not commonly used)

artifactTypeID

  • artifactTypeID: undefined | number

Description

The Artifact Type ID of the object that the list is being displayed for (e.g. 10 for the Document object)

dashboardData

  • dashboardData: undefined | string

Description

The data of the selected dashboard being displayed

dashboardID

  • dashboardID: undefined | number

Description

The Artifact ID of the selected dashboard being displayed

dashboardName

  • dashboardName: undefined | string

Description

The name of the selected dashboard being displayed

massProcesses

  • massProcesses: undefined | MassProcessDTO[]

Description

Mass Process data

relativityHttpClient

Description

An HTTP client that can be used to send requests to internal Relativity APIs or external non-Relativity APIs

servicePathOverrides

  • servicePathOverrides: undefined | { [key: string]: string; }

Description

Service Path Override values

toggles

  • toggles: undefined | Record<string, boolean>

Description

Toggles

useLiquidForms

  • useLiquidForms: undefined | boolean

Description

The use liquid forms setting.

userTimezone

  • userTimezone: string

Description

The timezone string for the current user (e.g. "America/Chicago")

utilities

Description

Utility functions made available for scripts

viewID

  • viewID: undefined | number

Description

The Artifact ID of the selected view being displayed

workspaceID

  • workspaceID: undefined | number

Description

The ID of the workspace that the list is being displayed for, -1 refers to the admin workspace