Projections

Update projection properties.

Validating model point files is limited to 100K rows with 20 columns.<br/><b>For larger model point files set ValidateModelPointFiles to false.</b>

patch/api/v1/Projections/{projectionId}

Request

Base URL
https://api.slopesoftware.com (the document declares no server; this is the origin it was published from)
Auth
HTTP bearer
TypeScript
https://skmtc.dev/slopesoftware/apis/akur8-life-api/docs/api/v1/Projections/:projectionId/patch.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

projectionIdinteger required

Projection ID

Request body

namestring nullable

Projection Name - Can be updated for projections in any status

scenarioTableIdinteger nullable

Scenario Table ID

scenarioSubsetstring nullable

Scenario Subset

startDatestring date-time nullable

Start Date

periodInMonthsinteger nullable

Period in Months

outputAllResultsboolean nullable

Output All Results

disableModelPointOutputboolean nullable

Disable Model Point Output

forceStaticProcessingboolean nullable

Force Static Processing

numberOfCoresinteger nullable

Number of Cores

validateModelPointFilesboolean nullable

Validate Model Point Files

virtualFoldersstring[] nullable

Virtual Folders - Array of folder paths. Projections can exist in multiple folders. If empty array is passed, all folders are cleared. If not passed, folders are not updated. Can be updated for projections in any status.

tagsstring[] nullable

Tags - Array of tag names. If empty array is passed, all tags are cleared. If not passed, tags are not updated. Can be updated for projections in any status.

isLockedboolean nullable

Lock or unlock a projection. Locking requires LockProjections permission or a workspace token. Unlocking requires UnlockProjections permission or a workspace token. Only projections in a completed/failed status can be locked.

Response

idinteger

namestring nullable

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