Application Programming Interface (API)

Note

This section is under construction.

GET /Api/About

Returns a version info record containing version number and build date.

Status Codes

  • 200 OK – About info record.

GET /Api/Actions/{id}

Gets the action with the specified id.

Parameters

  • id (integer:int32, required) – The id of the action.

Status Codes
DELETE /Api/Actions/{id}

Deletes the action with the specified id.

Parameters

  • id (integer:int32, required) – The id of the action that should be deleted.

Status Codes
POST /Api/Actions

Creates a new action action.

Status Codes
GET /Api/Actions/{id}/Settings

Get the action with the provided id

Parameters

  • id (integer:int32, required) –

Status Codes
PATCH /Api/Actions/{id}/Settings

Patch the action settings for action with provided id.

Parameters

  • id (integer:int32, required) – Action id

Status Codes
PUT /Api/Actions/{id}/Settings

Sets the action settings of the provided action settings xml file.

Parameters

  • id (integer:int32, required) – Id of the action that should be set.

Status Codes
PUT /Api/Actions/{id}/Clone

Clones the (standard)action to a custom action.

Parameters

  • id (integer:int32, required) – The id of the action.

Query Parameters

  • custom (boolean) – Create a custom action, only applicable when the original action is a standard action

Status Codes
GET /Api/Actions/{id}/DataSources

Get the action datasources for the action with the provided id

Parameters

  • id (integer:int32, required) –

Status Codes
PUT /Api/Actions/{id}/DataSources

Sets the action settings of the provided action data source config xml file.

Parameters

  • id (integer:int32, required) – Id of the action that should be cloned.

Status Codes
POST /Api/Actions/UploadActionZipFile/{idWorkspace}

Creates an upload task that creates an action from an action+data zip file. Returns the task id for monitoring the progress.

Parameters

  • idWorkspace (integer:int32, required) – Id of the action that should be cloned.

Status Codes
PUT /Api/Actions/UpdateMetaData/{id}

Updates the action meta data.

Parameters

  • id (integer:int32, required) – The id of the action.

Status Codes
PUT /Api/Actions/ConvertToCustomAction/{id}

Converts the (standard)action to a custom action.

Parameters

  • id (integer:int32, required) – The id of the action.

Status Codes
PUT /Api/Actions/UpdateStandardActionVersion/{id}

Updates the (standard)action to use the latest standard action version.

Parameters

  • id (integer:int32, required) – The id of the action.

Status Codes
PUT /Api/Actions/SetIsCompute/{id}

Specifies whether the data of a (sub)module of the action should be computed or obtained from data.

Parameters

  • id (integer:int32, required) – The id of the action.

Status Codes
PUT /Api/Actions/SetActionDataSource/{id}

Adds a data source to the data source configuration of the action.

Parameters

  • id (integer:int32, required) – The id of the action.

Status Codes
PUT /Api/Actions/ReplaceActionDataSource/{id}

Replaces an action data source with another data source.

Parameters

  • id (integer:int32, required) – The id of the action.

Status Codes
GET /Api/Actions/GetSummary/{id}

Returns the summary of the action with the specified id.

Parameters

  • id (integer:int32, required) – The id of the action.

Status Codes
GET /Api/Actions/GetDataReadingSummary/{id}

Returns the data reading summary of the specified (sub-)module for the action with the specified id.

Parameters

  • id (integer:int32, required) – The id of the action.

Query Parameters

  • actionType (required) – The id of the (sub-)module

Status Codes
GET /Api/Actions/GetDataSelection/{id}

Retrieves a data entities page for the provided table.

Parameters

  • id (integer:int32, required) –

Query Parameters

  • entityType (required) –

Status Codes
GET /Api/Actions/GetDataReadingEntityRecords/{id}

Retrieves a data entities page for the provided table.

Parameters

  • id (integer:int32, required) –

Query Parameters

  • tableGroupId (required) –

  • scopingType (required) –

  • filteredStatusTypes (array) –

  • page (integer:int32) –

  • pageSize (integer:int32) –

  • sort (string) –

  • order (string) –

Status Codes
GET /Api/Actions/GetDataLinkingEntityRecords/{id}

Get action data linking records.

Parameters

  • id (integer:int32, required) –

Query Parameters

  • tableGroupId (required) –

  • scopingType (required) –

  • referencedScopingType (required) –

  • filteredStatusTypes (array) –

  • page (integer:int32) –

  • pageSize (integer:int32) –

  • sort (string) –

  • order (string) –

Status Codes
PUT /Api/Actions/SetScope/{id}

Sets the action scope. I.e., specify which data entities (specified by their codes) should be considered in the action.

Parameters

  • id (integer:int32, required) – The id of the action.

Status Codes
PUT /Api/Actions/ClearScope/{id}

Clears the action scope/data selection.

Parameters

  • id (integer:int32, required) – The id of the action.

Status Codes
PUT /Api/Actions/ExtendScope/{id}

Extends the action scope.

Parameters

  • id (integer:int32, required) – The id of the action.

Status Codes
PUT /Api/Actions/ReduceScope/{id}

Reduces the action scope.

Parameters

  • id (integer:int32, required) – The id of the action.

Status Codes
GET /Api/Actions/{id}/Settings/Export

Returns the settings xml of the action with the specified id.

Parameters

  • id (integer:int32, required) – The id of the action.

Status Codes
GET /Api/Actions/{id}/DataSources/Export

Returns the data sources xml of the action with the specified id.

Parameters

  • id (integer:int32, required) – The id of the action.

Status Codes
GET /Api/Actions/{id}/Export

Returns all settings and data of the action as a zip-file. Project data is included in the form of csv files (zipped csv format).

Parameters

  • id (integer:int32, required) – The id of the action.

Query Parameters

  • format – The format of the data in the zip

Status Codes
GET /api/Actions/FileUploadProgress

Retrieves the task progress of the upload task with the specified task id.

Query Parameters

  • taskId (string, required) – The task id of the upload task.

Status Codes
GET /Api/Outputs/Get/{id}

Gets the output with the specified id.

Parameters

  • id (integer:int32, required) – The id of the output.

Status Codes
GET /Api/Outputs/GetFromAction/{idAction}

Gets the outputs of the action with the specified id. Returns a list of OutputInfoViewModel records.

Parameters

  • idAction (integer:int32, required) – Id of the action.

Status Codes
GET /Api/Outputs/GetOutputReportToc/{id}

Get the output summary deserialized into the object hierarchy.

Parameters

  • id (integer:int32, required) – Id of the output.

Status Codes
GET /Api/Outputs/GetOutputReportTocs

Gets the hierarchical output report summary toc objects of the outputs with the specified ids.

Query Parameters

  • ids (array) – Ids of the outputs.

Status Codes
GET /Api/Outputs/GetOutputReportSection

Gets output report section with the specified id of the output with the specified id.

Query Parameters

  • idOutput (integer:int32, required) – Id of the output

  • idSection (string:guid, required) – Id of the section.

Status Codes
GET /Api/Outputs/GetShortOutputSummary

Gets short output report summary with the specified id of the output

Query Parameters

  • idOutput (integer:int32, required) – Id of the output

Status Codes
GET /Api/Outputs/GetOutputReportTableData

Gets output table data section with the specified id of the output with the specified id.

Query Parameters

  • idOutput (integer:int32, required) – Id of the output.

  • idSection (string:guid, required) – Id of the section.

  • maxRecords (integer:int32, required) – Maximum number of records.

  • isTree (boolean, required) – if true, the hierarchy defining data should be incorporated

Status Codes
GET /Api/Outputs/GetOutputReportTableContent

Gets output table data section with the specified id of the output with the specified id.

Query Parameters

  • idOutput (integer:int32, required) – Id of the output.

  • idSection (string:guid, required) – Id of the section.

  • caption (string, required) – Table caption

  • maxRecords (integer:int32, required) – Maximum number of records.

  • columnOrder (string, required) – Comma separated list of column indices determining the shown columns

  • isTree (boolean, required) – if true, the hierarchy defining data should be incorporated

  • rotate (boolean, required) – if true, the rows and columns are switched, effectively rotating the table

Status Codes
GET /Api/Outputs/GetOutputReportChart

Gets output table data section with the specified id of the output with the specified id.

Query Parameters

  • idOutput (integer:int32, required) – Id of the output.

  • idSection (string:guid, required) – Id of the section.

Status Codes
GET /Api/Outputs/GetTaskSettingsSection

Gets the settings section content of the task with the specified id.

Query Parameters

  • idTask (integer:int32, required) – Id of the task.

Status Codes
GET /Api/Outputs/DownloadFullPdf

Returns pdf file of the output report with the specified id.

Query Parameters

  • idOutput (integer:int32, required) – Id of the output.

Status Codes
GET /Api/Outputs/DownloadShortReportPdf

Returns pdf file of the output report with the specified id.

Query Parameters

  • idOutput (integer:int32, required) – Id of the output.

Status Codes
GET /Api/Outputs/DownloadSectionPdf

Returns pdf file of the report section with the specified id of the output with the specified id.

Query Parameters

  • idOutput (integer:int32, required) – Id of the output.

  • idSection (string:guid, required) – Id of the section.

Status Codes
GET /Api/Outputs/GetSectionHtml

Returns pdf file of the report section with the specified id of the output with the specified id.

Query Parameters

  • idOutput (integer:int32, required) – Id of the output.

  • idSection (string:guid, required) – Id of the section.

Status Codes
GET /Api/Outputs/GetShortReportHtml

Returns pdf file of the report section with the specified id of the output with the specified id.

Query Parameters

  • idOutput (integer:int32, required) – Id of the output.

Status Codes
GET /Api/Outputs/GetFullReportHtml

Returns pdf file of the report section with the specified id of the output with the specified id.

Query Parameters

  • idOutput (integer:int32, required) – Id of the output.

Status Codes
GET /Api/Outputs/DownloadReportCsvZip

Returns zip file with csv files of the tables of the output report of the output with the specified id.

Query Parameters

  • idOutput (integer:int32, required) – Id of the output.

Status Codes
GET /Api/Outputs/DownloadTableCsv

Returns csv file of the report table with the specified id of the output with the specified id.

Query Parameters

  • idOutput (integer:int32, required) – Id of the output.

  • idSection (string:guid, required) – Id of the section.

Status Codes
GET /Api/Outputs/DownloadSectionCsvZip

Returns zip file with csv files of the tables of the section with the specified id of the output with the specified id.

Query Parameters

  • idOutput (integer:int32, required) – Id of the output.

  • idSection (string:guid, required) – Id of the section.

Status Codes
GET /Api/Outputs/DownloadRawData

Returns a zip file of the generated raw data of the output with the specified id.

Query Parameters

  • idOutput (integer:int32, required) – Id of the output.

Status Codes
GET /Api/Repositories

Get all repositories for the user (tree)

Query Parameters

  • path (string) –

Status Codes
POST /Api/Repositories

Create new repository from the provided model

Status Codes
PUT /Api/Repositories

Change the repository settings with the provided model

Status Codes
GET /Api/Repositories/{id}

Get the repository details for the provided id

Parameters

  • id (integer:int32, required) –

Status Codes
DELETE /Api/Repositories/{id}

Remove the repository with the provided id, force delete if necessary

Parameters

  • id (integer:int32, required) – Repository id

Query Parameters

  • force (boolean) – Force delete (also if there are datasources still in use)

Status Codes
PATCH /Api/Repositories/{id}

Apply a JsonPatch to a repository

Parameters

  • id (integer:int32, required) –

Status Codes
POST /api/Repositories/ChangeOwner
Status Codes
POST /api/Repositories/AddUserShare
Status Codes
POST /api/Repositories/UpdateUserShare
Status Codes
POST /api/Repositories/RemoveUserShare
Status Codes
POST /api/Repositories/AddGroupShare
Status Codes
POST /api/Repositories/UpdateGroupShare
Status Codes
POST /api/Repositories/RemoveGroupShare
Status Codes
GET /Api/Repositories/{id}/DataSources

Gets the data sources that are in use in the repository with the specified id.

Parameters

  • id (integer:int32, required) –

Query Parameters

  • remote (boolean) –

  • inUse (boolean) –

Status Codes
GET /Api/Repositories/{id}/DataSources/Versions

Gets the data sources that are in use in the repository with the specified id.

Parameters

  • id (integer:int32, required) –

Query Parameters

  • checksum (string) –

Status Codes
GET /Api/Repositories/{id}/DataSources/Usage

Gets all project information still associated with any datasources in the repository or any subrepositories

Parameters

  • id (integer:int32, required) – Id of the main repository to search

Status Codes
GET /Api/Tasks/{id}

Returns the task with the specified id.

Parameters

  • id (integer:int32, required) – The id of the task.

Status Codes
DELETE /Api/Tasks/{id}

Deletes the task with the specified id.

Parameters

  • id (integer:int32, required) –

Status Codes
GET /Api/Tasks/Get/{id}

Returns the task with the specified id.

Parameters

  • id (integer:int32, required) – The id of the task.

Status Codes
GET /Api/Tasks/GetWorkspaceTasks/{idWorkspace}

Gets all tasks of a workspace.

Parameters

  • idWorkspace (integer:int32, required) – The id of the workspace.

Status Codes
PUT /Api/Tasks/UpdateDescription/{id}

Updates the task description.

Parameters

  • id (integer:int32, required) – The id of the task.

Status Codes
GET /Api/Tasks/{id}/Log

Retrieves the latest tasklog of the task with the specified id.

Parameters

  • id (integer:int32, required) – The id of the task.

Status Codes
POST /Api/Tasks/ScheduleTask/{idAction}

Starts a calculation task for the given action and returns the id of this task.

Parameters

  • idAction (integer:int32, required) – The id of the action from which the task should be spawned.

Status Codes
POST /Api/Tasks/ScheduleSubTask/{idAction}

Starts a concentration model calculation task for the given project and returns the id of this task.

Parameters

  • idAction (integer:int32, required) – The id of the action.

Query Parameters

  • actionType (required) – The type of the sub-module of the action.

Status Codes
GET /Api/Tasks/{id}/Status

Returns the progress of the specified task.

Parameters

  • id (integer:int32, required) – Id of the task.

Status Codes
GET /Api/Tasks/GetActiveTaskStatuses/{idWorkspace}

Gets the statuses of all active tasks of a workspace.

Parameters

  • idWorkspace (integer:int32, required) – Id of the workspace.

Status Codes
PUT /Api/Tasks/Abort/{id}

Aborts the execution of the task with the specified id.

Parameters

  • id (integer:int32, required) – The id of the task.

Status Codes
DELETE /Api/Tasks/Delete/{id}

Deletes the task with the specified id.

Parameters

  • id (integer:int32, required) –

Status Codes
DELETE /Api/Tasks/BatchDelete

Deletes the tasks with the specified ids.

Query Parameters

  • ids (array) – The ids of the tasks that should be deleted.

Status Codes
GET /Api/Tasks/DownloadTaskZip/{id}

Download a zip file containing the task’s settings and data at the time of the task’s creation. The task’s settings and data sources are deserialized from the ProjectSettings and DataSourceSettings fields

Parameters

  • id (integer:int32, required) – The ID of the task

Status Codes
GET /Api/Workspaces

Gets all workspaces available to the user.

Status Codes
POST /Api/Workspaces

Creates a workspace based on the provided form data.

Status Codes
GET /Api/Workspaces/{id}

Gets the workspace with the specified id.

Parameters

  • id (integer:int32, required) – The id of the workspace.

Status Codes
PUT /Api/Workspaces/{id}

Updates the workspace meta data.

Parameters

  • id (integer:int32, required) – The id of the workspace that is to be updated.

Status Codes
DELETE /Api/Workspaces/{id}

Deletes the workspace with the specified id.

Parameters

  • id (integer:int32, required) – The id of the workspace that should be deleted.

Status Codes
GET /Api/Workspaces/{id}/Actions

Gets all actions of the workspace with the specified id.

Parameters

  • id (integer:int32, required) – The id of the workspace.

Status Codes
POST /Api/Workspaces/{id}/Actions/Settings

Create a new action from the provided settings Dto in the workspace for which the id is provided

Parameters

  • id (integer:int32, required) –

Status Codes
POST /Api/Workspaces/{id}/DataSources/Versions

Adds a data source version to the workspace.

Parameters

  • id (integer:int32, required) – The id of the workspace.

Status Codes
GET /Api/Workspaces/{id}/DataSources/Versions

Returns all data source versions used in the workspace with the specified id.

Parameters

  • id (integer:int32, required) – The id of the workspace.

Status Codes
DELETE /Api/Workspaces/{id}/DataSources/Versions/{idDataSourceVersion}

Removes a data source version from the workspace.

Parameters

  • id (integer:int32, required) – The id of the workspace.

  • idDataSourceVersion (integer:int32, required) – The id of the data source version.

Status Codes
GET /api/ActionClasses/Get

Returns a collection of the action class definitions available in the toolbox.

Status Codes
GET /api/ActionTypes/Get

Returns a collection of the action type definitions available in the toolbox.

Status Codes
GET /api/DataFormats/Get

Returns a collection of the data format definitions available in the toolbox.

Status Codes
GET /api/ScopingTypes/Get

Returns a collection of the scoping type definitions available in the toolbox.

Status Codes
GET /api/StandardActionTypes/Get

Returns a collection of the standard action type definitions available for the user.

Status Codes
GET /api/UnitDefinitions/Get

Returns a collection of the unit definitions available in the toolbox.

Status Codes