Projections

Get Projection Details by Id.

get/api/v1/Projections/{projectionId}

Request

Path parameters

projectionIdinteger required

Projection ID

Query parameters

Fieldsstring

Optional parameter to filter the top-level fields that are returned. The list must be in CSV format. Example: field1,field2,field3

Response

OK

idinteger
namestring nullable
status'NotStarted' | 'Running' | 'Completed' | 'Failed' | 'Queued' | 'Cancelled' | 'CompletedWithErrors' | 'ErrorLimitReached' | 'WaitingForInserts' | 'Queuing' | 'Deleting' | 'Preparing' | 'FailedToStart' | 'Validating' | 'ValidationFailed' | 'CompletedWithWarnings'
isRunningboolean
startDatestring date-time
periodInMonthsinteger
runStartDateUtcstring date-time nullable
runCompletedDateUtcstring date-time nullable
outputAllResultsboolean
disableModelPointOutputboolean
forceStaticProcessingboolean
isLockedboolean
archivalStatus'Unarchived' | 'Archived' | 'Unarchiving'

A projection's archival status as the public API reports it.

numberOfCoresinteger
scenarioTableIdinteger nullable
virtualFoldersstring[] nullable
tagsstring[] nullable

Changes

No recorded changes to this operation across all 1 revision of this API.