Interface: ObjectManagerRequest

ObjectManagerApi.ObjectManagerRequest

Description

Request information sent to Object Manager

Properties

Properties

activeArtifactId

OptionalactiveArtifactId: number

The current artifact type ID


cancellable

cancellable: null | boolean

If request should be cancellable


condition

condition: string

Translated user condition string


convertNumberFieldValuesToString

convertNumberFieldValuesToString: boolean

Whether to convert number field values to strings


executingSavedSearchId

OptionalexecutingSavedSearchId: number

The current Saved Search ID


executingViewId

OptionalexecutingViewId: number

The current View artifact ID


fields

fields: FieldRef[]

List of field names


includeIdWindow

includeIdWindow: boolean

Whether to include the ID window


isAdHocQuery

isAdHocQuery: boolean

Boolean for if this is an adhoc query


objectType

objectType: Object

The current object type information

Type declaration

Name Type Description
artifactTypeID number The current object artifact type ID

queryHint

queryHint: null | string

The query hint string


rankSortOrder

rankSortOrder: null | string

The rank sort order


relationalField

relationalField: null | FieldRef

The current relational field information


rowCondition

rowCondition: string

Translated row condition string


sampleParameters

sampleParameters: null | SampleParameters | SampleExistingToken

The current Sample information


searchProviderCondition

searchProviderCondition: null | SearchProviderCondition

The current Search Provider condition information


sorts

sorts: ObjectManagerSort[]

The current item list sorts information