Interface: PageInfoApi

PageInfoApi.PageInfoApi

Description

Refer to PageInfoApiV1

Properties

• getFilters
• getRelationalField
• getSampleState
• getSorts
• v1

Properties

getFilters

• getFilters: (workspaceID: number, artifactTypeID: number) => undefined | Record<string, any>

Type declaration

• (workspaceID, artifactTypeID): undefined | Record<string, any>

Parameters

Name	Type
workspaceID	number
artifactTypeID	number

Returns

undefined | Record<string, any>

Deprecated

Use 'v1.getFilters' instead.

getRelationalField

• getRelationalField: (workspaceID: number, artifactTypeID: number) => undefined | number

Type declaration

• (workspaceID, artifactTypeID): undefined | number

Parameters

Name	Type
workspaceID	number
artifactTypeID	number

Returns

undefined | number

Deprecated

Use 'v1.getRelationalField' instead.

getSampleState

• getSampleState: (workspaceID: number, artifactTypeID: number) => undefined | Record<string, any>

Type declaration

• (workspaceID, artifactTypeID): undefined | Record<string, any>

Parameters

Name	Type
workspaceID	number
artifactTypeID	number

Returns

undefined | Record<string, any>

Deprecated

Use 'v1.getSampleState' instead.

getSorts

• getSorts: (workspaceID: number, artifactTypeID: number) => undefined | Record<string, any>

Type declaration

• (workspaceID, artifactTypeID): undefined | Record<string, any>

Parameters

Name	Type
workspaceID	number
artifactTypeID	number

Returns

undefined | Record<string, any>

Deprecated

Use 'v1.getSorts' instead.

v1

• v1: PageInfoApiV1

Contains the updated v1 version of the PageInfoApi