Introduction


This document is a markdown export generated from the DataIntegration OpenAPI Specification.

Rather than using this page, you should use an Open API user interface (such as https://petstore.swagger.io/ ) and load the JSON document there. This page is mainly here for the search index and deep links (smile).

API Description

/health

GET

Summary:

Health

Description:

Returns config and health information about components DataIntegration depends on like DataPlatform and Spark. The status property values are either 'UP' or 'DOWN'. If any sub-component ist down, then the parent component is also marked down. Not configured components are hidden.

Responses
CodeDescription
200If the system is healthy
503If the system is unhealthy

/logout

GET

Summary:

Logout

Description:

Log outs the user and redirects them to the configured logout page.

Responses
CodeDescription
303Redirects to the configured logout page.

/version

GET

Summary:

Version

Description:

The version of the eccenca DataIntegration application.

Responses
CodeDescription
200The version as plain text.

/api/core/taskPlugins

GET

Summary:

Task plugins

Description:

A list of plugins that can be created as workspace tasks, e.g. datasets, transform tasks etc. The result of this endpoint only contains meta data of the plugin, i.e. title, description and categories. To fetch the schema details of a specific plugin use the /plugin endpoint.

Parameters
NameLocated inDescriptionRequiredSchema
addMarkdownDocumentationqueryAdd markdown documentation to the result.Noboolean
textQueryqueryAn optional (multi word) text query to filter the list of plugins.Nostring
categoryqueryAn optional category. This will only return plugins from the same category.Nostring
Responses
CodeDescription
200Success

/api/core/plugins/{pluginId}

GET

Summary:

Plugin description

Description:

The plugin description of a specific plugin, including meta data and JSON schema.

Parameters
NameLocated inDescriptionRequiredSchema
pluginIdpathThe plugin identifier.Yesstring
addMarkdownDocumentationqueryAdd markdown documentation to the result.Noboolean
prettyqueryIf true, JSON output will be pretty printed.Noboolean
Responses
CodeDescription
200Contains the typical meta data of a plugin like title, categories and description. The 'taskType' property is optional and specifies the task type a task related plugin, e.g. workflow, dataset etc., belongs to. The task type must be specified when creating tasks via the generic /tasks endpoint. The JSON schema part of the plugin parameters is described in the 'properties' object. Besides title and description each parameter has the JSON type, which can only be "string" or "object" at the moment. The 'parameterType' specifies the internal data type. For "object" types this can be ignored, for "string" parameter types this gives a hint at what kind of UI widget is appropriate and what kind of validation could be applied. The 'value' property gives the default value when this parameter is not specified. The 'advanced' property marks the parameter as advanced and acts as a hint that this parameter should be somehow handled differently by the UI. If the 'visibleInDialog' property is set to false, then this parameter should not be set from a creation or update dialog. Usually this parameter is complex and is modified in special editors, e.g. the mapping editor. The pluginId property specifies the ID of the plugin and is also set for all plugin parameters that are plugins themselves. The plugin ID is needed, e.g. for the auto-completion of parameter values. A parameter can have an autoCompletion property that specifies how a parameter value can or should be auto-completed. If allowOnlyAutoCompletedValues is set to true then the UI must make sure that only values from the auto-completion are considered as valid. If autoCompleteValueWithLabels is set to true, then the auto-completion values might have a label in addition to the actual value. Only the label should be presented to the user then. The autoCompletionDependsOnParameters array specifies the values of parameters from the same object, a specific parameter depends on. These must be send in the auto-completion request in the same order.

/api/core/usages/plugins/{pluginId}

GET

Summary:

Plugin usages

Description:

Returns a list of all usages of a given plugin. Currently lists usages in projects as tasks and as within linking and transform rules.

Parameters
NameLocated inDescriptionRequiredSchema
pluginIdpathThe plugin identifier.Yesstring
Responses
CodeDescription
200Success

/api/openapi/openapi.json

GET

Summary:

Generate OpenAPI JSON

Description:

Generate OpenAPI specification as JSON

Responses
CodeDescription
200Success

/api/openapi/openapi.yml

GET

Summary:

Generate OpenAPI YAML

Description:

Generate OpenAPI specification as YAML

Responses
CodeDescription
200Success

/api/openapi/validate

GET

Summary:

Validate OpenAPI

Description:

Validate OpenAPI specification

Parameters
NameLocated inDescriptionRequiredSchema
urlqueryThe URL of the OpenAPI specification. Leave empty for validating the current OpenAPI spec.Nostring
Responses
CodeDescription
200Success

/api/profiling/validateForeignKey

POST

Summary:

Validate foreign key

Description:

Validates if all foreign keys in a given column correspond to primary keys in another table. The path properties are in Silk path syntax.

Responses
CodeDescription
200The validation completed.
400Invalid user input.
500An internal issue prevented the validation from completing.

/api/profiling/validatePrimaryKey

POST

Summary:

Validate primary key

Description:

Validates if all values in a primary key column are unique. The path properties are in Silk path syntax.

Responses
CodeDescription
200The validation completed.
400Invalid user input.
500An internal issue prevented the validation from completing.

/api/profiling/profileType/{project}/{datasetTask}

POST

Summary:

Profile dataset type

Description:

Run data type detection and value profiling on a specific type of a dataset.Run data type detection and value profiling on a specific type of a dataset.

Parameters
NameLocated inDescriptionRequiredSchema
projectpathThe project identifier.Yesstring
datasetTaskpathThe dataset name.Yesstring
Responses
CodeDescription
200Profiling result.
404Not found.

/api/profiling/schemaClass/{projectId}/{datasetTask}

GET

Summary:

Schema classs info

Description:

The item types that a user can restrict the search to. The selected type will also influence the available facets.

Parameters
NameLocated inDescriptionRequiredSchema
projectIdpathID of the Project.Yesstring
datasetTaskpathThe dataset identifier.Yesstring
typePathqueryThe source type path the schema class information is requested for, in normalized form.Yesstring
Responses
CodeDescription
200Success
404Not found.

/api/profiling/schemaClass/{projectId}/{datasetTask}/exampleValues

GET

Summary:

Schema path example values

Description:

Returns example values for each source path of a specific source class.

Parameters
NameLocated inDescriptionRequiredSchema
projectIdpathID of the Project.Yesstring
datasetTaskpathThe dataset identifier.Yesstring
typePathqueryThe source type path the schema class information is requested for, in normalized form.Yesstring
Responses
CodeDescription
200Success

/api/profiling/schemaClass/{projectId}/{transformTask}/ruleExampleValues

GET

Summary:

Schema path rule example values

Description:

Returns example values for each source path of a specific transform rule.

Parameters
NameLocated inDescriptionRequiredSchema
projectIdpathID of the Project.Yesstring
transformTaskpathID of the transform rule.Yesstring
ruleIdOptqueryThe ID of the transform rule that example values should be fetched for. This makes it unnecessary for the UI to know the full type path itself. It just needs to know the rule ID it currently operates on. If no rule ID is provided it will default to the base type.Nostring
Responses
CodeDescription
200Success

/api/workflow/info

GET

Summary:

Workflow information list

Description:

Get a list of all workflows of the workspace or a specific project, with information about how they can be executed via REST APIs.

Parameters
NameLocated inDescriptionRequiredSchema
projectIdqueryIf set then only workflows from this particular project are returned.Nostring
Responses
CodeDescription
200Success
404If the specified project has not been found.

/api/workflow/config/{projectId}/{workflowId}/ports

GET

Summary:

Workflow nodes port config

Description:

Returns information about what port configuration nodes in a workflow can have.

Parameters
NameLocated inDescriptionRequiredSchema
projectIdpathThe project identifierYesstring
workflowIdpathThe workflow identifierYesstring
Responses
CodeDescription
200A workflow node port config can be configured on three different levels. The most specific one is the config by node ID, i.e. of a specific node in the workflow graph. The next level is the task level and contains the port config for a concrete project task that does not have a port config that is determined by its item type. The most general level is the item type level, where the item type itself defines the port config. For a specific node in a workflow the most specific matching level should be taken, e.g. if a node has a port config by node ID this should be used. Each port config specifies the min. number of ports and an optional max. number of ports. If the max. number is missing, this basically means that an arbitrary number of inputs/ports are allowed.
404If the specified project or workflow has not been found.

/api/workflow/info/{projectId}/{workflowId}

GET

Summary:

Workflow information

Description:

Get information about how a specific workflow can be executed via REST APIs.

Parameters
NameLocated inDescriptionRequiredSchema
projectIdpathThe project identifierYesstring
workflowIdpathThe workflow identifierYesstring
Responses
CodeDescription
200Success
404If the specified project or workflow has not been found.

/api/workflow/result/{projectId}/{workflowId}

GET

Summary:

Parameterized workflow execution result

Description:

For a GET request the parameter and values are provided via the query string of the URL. In order to provide multiple values for an input property, the same query parameter should be used multiple times, e.g. inputProp=value+1&inputProp=value+2. The responses are the same as for the POST request.

Parameters
NameLocated inDescriptionRequiredSchema
projectIdpathThe project identifierYesstring
workflowIdpathThe workflow identifierYesstring
Responses
CodeDescription
200If the workflow was successful. The result of the variable output dataset is returned in the response.
204If the workflow was successful, but contains no variable output dataset.
400Invalid request, e.g. no request parameters provided.
404If the specified project or workflow has not been found.
406If no response in any of the requested mime types could be produced.
500The workflow execution has failed.

POST

Summary:

Parameterized workflow execution result

Description:

Executes a workflow with parameters from the request query string or form URL encoded body. Compatible with all workflows that contain a single variable dataset that is used as input dataset and a single variable dataset as output – each dataset can be used several times in the same workflow. The output data type is specified via the ACCEPT header. The result is returned as the requested mime type, the content is the file content of the corresponding dataset, e.g. XML, CSV etc. A single entity is build from the provided request parameters and injected into the variable source dataset. There must be at least one form or query parameter specified in the request. If empty entities as input must be supported, a POST request with empty JSON or XML object/element should be used, see below. For some data types (JSON, XML and CSV), the POST body can contain arbitrary content that the data source is expected to have. This goes beyond the simple query or form parameter input, where only exactly one input entity would be generated. The corresponding content type must be specified in these cases.

Parameters
NameLocated inDescriptionRequiredSchema
projectIdpathThe project identifierYesstring
workflowIdpathThe workflow identifierYesstring
Responses
CodeDescription
200If the workflow was successful. The result of the variable output dataset is returned in the response.
204If the workflow was successful, but contains no variable output dataset.
400Invalid request, e.g. no request parameters provided.
404If the specified project or workflow has not been found.
406If no response in any of the requested mime types could be produced.
500The workflow execution has failed.

/api/workspace/initFrontend

GET

Summary:

Init frontend

Description:

Returns information that is necessary for the frontend initialization or otherwise needed from the beginning on.

Responses
CodeDescription
200The emptyWorkspace parameter signals if the workspace is empty or contains at least one project. The initialLangauge parameter returns the initial language (either 'de' or 'en') that has been extracted from the Accept-language HTTP header send by the browser. The maxFileUploadSize specifies the max. file size in bytes. The dmBaseUrl is optional and returns the base URL, if configured in the DI config via parameter eccencaDataManager.baseUrl. The dmModuleLinks are only available if the DM base URL is defined. These are configured links to DM modules.

/api/workspace/pluginParameterAutoCompletion

POST

Summary:

Plugin parameter auto-completion

Description:

Auto-completion endpoint for plugin parameter values.

Responses
CodeDescription
200The response contains the result list of matching auto-completion results. The 'label' property is optional and may not be defined, even for parameters that are supposed to have labels. In this case the 'value' should be taken as label.

/api/workspace/projectImport

POST

Summary:

Project import resources

Description:

Project import resources are used for a multi step project import procedure that is comprised of multiple steps: 1. the project file upload, 2. the validation of the uploaded file, 3. the asynchronous execution of the project import and 4. the status of the running project import execution.

Responses
CodeDescription
201A project import resource with the returned ID has been created.

/api/workspace/projects

POST

Summary:

Create project

Description:

Create a new project by specifying a label and an optional description.

Responses
CodeDescription
201The project has been added. The URI of the new project is returned, which includes the automatically generated project ID.

/api/workspace/recentlyViewedItems

GET

Summary:

Recently viewed items

Description:

Fetch a list of the (max. 50) most recently accessed items, e.g. visited details pages or updated projects or tasks. The list is ordered by recency of the access, more recent coming first.

Responses
CodeDescription
200List of recently viewed items with: - Project ID and label, optional task ID and label (when the item is a task) - Item type, e.g. 'project', 'transform' etc. - The plugin ID for tasks - Item links of the returned item, e.g. details page etc.

/api/workspace/searchItems

POST

Summary:

Artifact search

Description:

Allows to search over all DataIntegration artifacts with text search and filter facets.

Responses
CodeDescription
200Search result

/api/workspace/searchTasks

POST

Summary:

Search Tasks

Description:

List all tasks that fulfill a set of filters. All JSON fields sent in the the request are optional. The request example reflects the default values that are chosen when a field is missing in the request.

Responses
CodeDescription
200Search result

/api/workspace/taskActivitiesStatus

GET

Summary:

Task activities status

Description:

Returns status information of a set of task activities. By default all task activities are returned.

Parameters
NameLocated inDescriptionRequiredSchema
projectIdqueryIf defined only task activities of a specific project are considered.Nostring
statusFilterqueryIf defined only task activities with a specific status are returned. Valid values are "Idle", "Not executed", "Finished", "Cancelled", "Failed", "Successful", "Canceling", "Running" and "Waiting". States "Idle" and "Not executed" are synonyms and "Idle" is kept only for backwards compatibility. State "Finished" is a union of following sub-states "Cancelled", "Failed" and "Successful". "Waiting" is the state of an activity being scheduled, but still waiting in queue for being executed.Nostring
Responses
CodeDescription
200Success

/api/workspace/projectImport/{projectImportId}

GET

Summary:

Project import details

Description:

The project import resource that was created by uploading a project file.

Parameters
NameLocated inDescriptionRequiredSchema
projectImportIdpathThe project import id.Yesstring
Responses
CodeDescription
200Details for the uploaded project file. The label, description and projectId properties were extracted from the uploaded file. The projectAlreadyExists property states that there already exists a project with the exact same ID. In that case special flags can be set for the subsequent request that starts the project import execution. The marshallerId is the detected project file format, in the example it is a project XML ZIP archive.
404If the provided import identifier does not exist.

POST

Summary:

Start project import

Description:

Starts a project import based on the import identifier.

Parameters
NameLocated inDescriptionRequiredSchema
projectImportIdpathThe project import id.Yesstring
generateNewIdqueryWhen enabled this will always generate a new ID for this project based on the project label. This is one strategy if a project with the original ID already exists.Noboolean
overwriteExistingqueryWhen enabled this will overwrite an existing project with the same ID. Enabling this option will NOT override the generateNewId option.Noboolean
newProjectIdqueryIf provided, this will adopt the given id for the imported project. Cannot be set together with 'generateNewId'.Nostring
Responses
CodeDescription
201The project import has been executed. The status of the project import can be requested via the status endpoint.
404The execution has not been started, yet, or the project import ID is not known.
409Returned if a project with the same ID already exists and neither generateNewId nor overwriteExisting is enabled. Also returned if the uploaded temporary project file has been deleted because it reached its max age.

DELETE

Summary:

Remove project import resource

Description:

Deletes the project import resource and the uploaded files. The delete request is idempotent.

Parameters
NameLocated inDescriptionRequiredSchema
projectImportIdpathThe project import id.Yesstring
Responses
CodeDescription
404If the provided import identifier does not exist.

/api/workspace/projectImport/{projectImportId}/status

GET

Summary:

Project import execution status

Description:

When the project import execution has been started, this will return the status of the project execution.

Parameters
NameLocated inDescriptionRequiredSchema
projectImportIdpathThe project import id.Yesstring
timeoutqueryThe timeout in milliseconds when this call should return if the execution is not finished, yet. This allow for long-polling the result.Nointeger
Responses
CodeDescription
200The status of the project execution. There are 3 types of responses: 1. The execution is still in progress, i.e. no 'success' property is defined. 2. The 'success' property is defined and set to true, which means that the import has been successful. 3. The 'success' property is defined and set to false, which means that the import has failed. The 'failureMessage' property gives the reason for the failure.
404The execution has not been started, yet, or the project import ID is not known.

/api/workspace/projects/{projectId}/clone

POST

Summary:

Clone project

Description:

Clones an existing project.

Parameters
NameLocated inDescriptionRequiredSchema
projectIdpathThe identifier of the project that is to be clonedYesstring
Responses
CodeDescription
201The body contains the meta data of the to be created project. The label is required and must not be empty. The description is optional.
404If the project does not exist.

/api/workspace/projects/{projectId}/failedTasksReport

GET

Summary:

Project tasks loading error report

Description:

Get a detailed loading error report for all tasks that could not be loaded in a project.

Parameters
NameLocated inDescriptionRequiredSchema
projectIdpathThe project identifierYesstring
Responses
CodeDescription
200Success
404If the project does not exist.

/api/workspace/projects/{projectId}/metaData

GET

Summary:

Retrieve project metadata

Description:

Metadata of the project, such as the label and description.

Parameters
NameLocated inDescriptionRequiredSchema
projectIdpathThe project identifierYesstring
Responses
CodeDescription
200Success
404If the project does not exist.

PUT

Summary:

Update project metadata

Description:

Update the meta data of the project, i.e. the label and description.

Parameters
NameLocated inDescriptionRequiredSchema
projectIdpathThe project identifierYesstring
Responses
CodeDescription
200Success
404If the project does not exist.

/api/workspace/projects/{projectId}/prefixes

GET

Summary:

Project prefixes

Description:

Project namespace prefix definitions that map from a prefix name to a URI prefix.

Parameters
NameLocated inDescriptionRequiredSchema
projectIdpathThe project identifierYesstring
Responses
CodeDescription
200Success
404If the project does not exist.

/api/workspace/projects/{projectId}/failedTasksReport/{taskId}

GET

Summary:

Project task loading error report

Description:

Get a detailed loading error report for a specific project task that could not be loaded in the project.

Parameters
NameLocated inDescriptionRequiredSchema
projectIdpathThe project identifierYesstring
taskIdpathThe task identifierYesstring
Responses
CodeDescription
200Success
404If the project does not exist.

/api/workspace/projects/{projectId}/prefixes/{prefixName}

PUT

Summary:

Add project prefix

Description:

Create or update the prefix URI for a specific prefix name.

Parameters
NameLocated inDescriptionRequiredSchema
projectIdpathThe project identifierYesstring
prefixNamepathThe prefix nameYesstring
Responses
CodeDescription
200Success
404If the project does not exist.

DELETE

Summary:

Remove project prefix

Description:

Deletes a prefix definition.

Parameters
NameLocated inDescriptionRequiredSchema
projectIdpathThe project identifierYesstring
prefixNamepathThe prefix nameYesstring
Responses
CodeDescription
200The prefix has been removed.
404If the project does not exist.

/api/workspace/projects/{projectId}/tasks/{taskId}/clone

POST

Summary:

Clone project task

Description:

Clones an existing project task.

Parameters
NameLocated inDescriptionRequiredSchema
projectIdpathThe project identifierYesstring
taskIdpathThe task identifierYesstring
Responses
CodeDescription
201The generated ID and the link to the task details page.
404If the project does not exist.

/api/workspace/projects/{projectId}/tasks/{taskId}/itemInfo

GET

Summary:

Item info

Description:

Frontend relevant information about a project task item, e.g. the item type of a task.

Parameters
NameLocated inDescriptionRequiredSchema
projectIdpathThe project identifierYesstring
taskIdpathThe task identifierYesstring
Responses
CodeDescription
200Success

GET

Summary:

Item links

Description:

All relevant links of this project task.

Parameters
NameLocated inDescriptionRequiredSchema
projectIdpathThe project identifierYesstring
taskIdpathThe task identifierYesstring
Responses
CodeDescription
200Success

/api/workspace/projects/{projectId}/tasks/{taskId}/relatedItems

GET

Summary:

Related items

Description:

Fetches all directly related items of a project task. Related items are all project tasks that either are directly referenced by the task itself or reference the task. Also any task from a workflow that is directly connected to this task, i.e. either input or output, is part of the result list.

Parameters
NameLocated inDescriptionRequiredSchema
projectIdpathThe project identifierYesstring
taskIdpathThe task identifierYesstring
textQueryqueryAn optional (multi word) text query to filter the list of plugins. Each word in the query has to match at least one sub-string from the label or the type property of a related item.Nostring
Responses
CodeDescription
200Success

/api/workspace/reports/list

GET

Summary:

List reports

Description:

Lists all available execution reports. Will only return reports if a execution report manager is configured.

Parameters
NameLocated inDescriptionRequiredSchema
projectIdqueryIf provided, only return reports from the given projectNostring
taskIdqueryIf provided, only return reports from the given taskNostring
Responses
CodeDescription
200Success

/api/workspace/reports/report

GET

Summary:

Retrieve report

Description:

Retrieves an individual execution report. Typically, /list is called first in order to enumerate all available reports and their attributes.

Parameters
NameLocated inDescriptionRequiredSchema
projectIdqueryThe project id of the reportYesstring
taskIdqueryThe task id of the reportYesstring
timequeryThe timestamp of the reportYesstring
Responses
CodeDescription
200Success

/api/workspace/searchConfig/types

GET

Summary:

Item type

Description:

The item types that a user can restrict the search to. The selected type will also influence the available facets.

Parameters
NameLocated inDescriptionRequiredSchema
projectIdqueryOptional parameter that fetches the types for a specific project. This will only display types that contain at least one item.Nostring
Responses
CodeDescription
200Success

/api/workspace/validation/sourcePath/{projectId}

POST

Summary:

Source path validation

Description:

Validates the syntax of a provided path string.

Parameters
NameLocated inDescriptionRequiredSchema
projectIdpathThe project identifierYesstring
Responses
CodeDescription
200Success

/core/plugins

GET

Summary:

All plugins

Description:

Lists all available plugins. The returned JSON format stays as close to JSON Schema as possible.

Parameters
NameLocated inDescriptionRequiredSchema
addMarkdownDocumentationqueryAdd markdown documentation to the result.Noboolean
Responses
CodeDescription
200Success

/core/plugins/{pluginType}

GET

Summary:

All plugins

Description:

Lists all available plugins that implement the given plugin type. The returned JSON format stays as close to JSON Schema as possible.

Parameters
NameLocated inDescriptionRequiredSchema
pluginTypepathFull class name of the plugin.Yesstring
addMarkdownDocumentationqueryAdd markdown documentation to the result.Noboolean
Responses
CodeDescription
200Success

/datasets/preview

POST

Summary:

Dataset preview

Description:

Get a content preview of a given dataset. The dataset must be already registered. If a preview of unregistered data is needed, the Resource Preview endpoint can be used. The main difference to the Resource Preview is the simpler usage with only the dataset name and project name as input. As opposed to the Resource Preview, the only type of preview is a structured preview, since the datasets were already registered and their parameters and parsing instructions are known. Returns 404 for non registered datasets and an empty previewContent for datasets that are registered but not available for reading or empty.

Responses
CodeDescription
200Content preview of the specified dataset.

/linking/tasks/{project}/{linkingTaskName}/evaluateLinkageRule

POST

Summary:

Evaluate provided linking rule

Description:

Evaluate a linking task based on a linkage rule that is provided with the request. This endpoint can be used to test temporary, alternative linkage rules without having to persist them first.

Parameters
NameLocated inDescriptionRequiredSchema
projectpathThe project identifierYesstring
linkingTaskNamepathThe task identifierYesstring
linkLimitqueryThe max. number of unique links that should be returned from the evaluation.Nointeger
timeoutInMsqueryThe max. time in milliseconds the matching stage of the linking execution is allowed to run. This timeout does not affect the loading stage.Nointeger
includeReferenceLinksqueryWhen true, this will return an evaluation of the reference links in addition to freshly matched links.Noboolean
Responses
CodeDescription
200Success
404If the specified project or task has not been found.

/linking/tasks/{project}/{task}/postLinkDatasource

POST

Summary:

Linking task execution with payload

Description:

Execute a specific linking rule against input data from the POST body.

Parameters
NameLocated inDescriptionRequiredSchema
projectpathThe project identifierYesstring
taskpathThe task identifierYesstring
Responses
CodeDescription
200Success
404If the specified project or task has not been found.

PUT

Summary:

Add reference link

Description:

Add a reference link to a specific linking task.

Parameters
NameLocated inDescriptionRequiredSchema
projectpathThe project identifierYesstring
taskpathThe task identifierYesstring
linkTypequeryThe link type, either "negative" or "positive".Yesstring
sourcequeryThe source entity URI.Yesstring
targetqueryThe target entity URI.Yesstring
Responses
CodeDescription
200If the reference link has been added successfully
404If the specified project or task has not been found.

DELETE

Summary:

Remove reference link

Description:

Remove a reference link from specific linking task.

Parameters
NameLocated inDescriptionRequiredSchema
projectpathThe project identifierYesstring
taskpathThe task identifierYesstring
sourcequeryThe source entity URI.Yesstring
targetqueryThe target entity URI.Yesstring
Responses
CodeDescription
200If the reference link has been removed successfully
404If the specified project or task has not been found.

GET

Summary:

Retrieve reference links

Description:

Retrieve all reference links of a specified linking task.

Parameters
NameLocated inDescriptionRequiredSchema
projectpathThe project identifierYesstring
taskpathThe task identifierYesstring
Responses
CodeDescription
200Success
404If the specified project or task has not been found.

PUT

Summary:

Update reference links

Description:

Update all reference links of a specified linking task.

Parameters
NameLocated inDescriptionRequiredSchema
projectpathThe project identifierYesstring
taskpathThe task identifierYesstring
generateNegativequeryIf true, negative reference links will be generated by interchanging the source and targets of the provided positive links. This will only produce correct results if the provided positive reference links are complete and model 1:1 relations.Yesboolean
Responses
CodeDescription
200If the reference links have been updated successfully
404If the specified project or task has not been found.

DELETE

Summary:

Delete reference links

Description:

Removes reference links from a specified linking task.

Parameters
NameLocated inDescriptionRequiredSchema
projectpathThe project identifierYesstring
taskpathThe task identifierYesstring
positivequeryIf true, positive reference links will be deleted.Yesboolean
negativequeryIf true, negative reference links will be deleted.Yesboolean
unlabeledqueryIf true, unlabeled reference links will be deleted.Yesboolean
Responses
CodeDescription
200If the reference links have been deleted successfully
404If the specified project or task has not been found.

/linking/tasks/{project}/{task}/referenceLinksEvaluated

GET

Summary:

Evaluate on reference links

Description:

Evaluates the current linking rule on all reference links.

Parameters
NameLocated inDescriptionRequiredSchema
projectpathThe project identifierYesstring
taskpathThe task identifierYesstring
Responses
CodeDescription
200Success
404If the specified project or task has not been found.

/ontologyMatching/matchVocabularyClassDataset

POST

Summary:

Match Dataset to Vocabulary Class

Description:

Matches properties of classes from a target vocabulary of a transformation task to one or more property candidates from the source dataset schema. Thus this is a target vocabulary focused matching operation against the source dataset and would for example be used if the caller wants to restrict the part of the vocabulary that should be matched and provide several candidates for each target property. For the given class URIs, only these target properties are considered in the matching process that have one of the classes or one of its parent classes defined as domain.

Responses
CodeDescription
200The matching has finished without errors. Per target property there are 1 to n Candidates candidates sorted by decreasing confidence. The 'type' property is a suggestion if this should become a value/data type mapping rule or an object rule. It can have values 'object' and 'value'. These values are also used in the rule generator endpoint. 'uri' is the source path of the data source and is only historically called URI. It's possible values are specified by the Silk path language. The optional 'graph' property is added to vocabulary properties when addMetaData = true. It specifies from which graph the resource has been read, e.g. the actual vocabulary graph not the namespace.
404Not found.

/ontologyMatching/rulesGenerator/{projectName}/{transformTaskId}/rule/{parentRuleId}

POST

Summary:

Rule Generator

Description:

Given correspondences, e.g. from the matching endpoint, it generates transformation rules based on on-the-fly generated schema and profiling information in the context of the parent rule. The rules are not added to the parent rule with this call by default, instead it returns the serialization of the rules. These serialized rules can then be added via subsequent REST calls for appending or replacing a rule.

Parameters
NameLocated inDescriptionRequiredSchema
projectNamepathThe project identifier.Yesstring
transformTaskIdpathThe transforn task identifier.Yesstring
parentRuleIdpathThe parent rule id.Yesstring
Responses
CodeDescription
200The matching has finished without errors.
400This happens when the parent rule cannot have children attached to it.
404Not found.

/resources/preview

POST

Summary:

Resource preview

Description:

Gets a content preview of a given resource. It serves 2 purposes. The first is kind of a file browser backend. For a given project and resource the service searches in the defined resource repository and tries to determine the type or content type of a resource to create a preview out of the first 1000 bytes (text ,xml, ...) or the first 100 records (orc, avro, csv, databases, ...). The second purpose is the to provide content preview for already known resources (i.e. all registered data sets and not only files). In this case the datasetInfo must be set in the preview request and is used to instantiate a Dataset subclass that is used directly to generate a preview.

Responses
CodeDescription
200Content preview of a given resource.

/scripts/projects/{project}/tasks/{task}/completions

POST

Summary:

Script task auto-completion

Description:

Returns auto completions for a script. The completions are based on the most recent script execution, i.e., the script needs to be executed in the workflow prior to requesting the completions.

Parameters
NameLocated inDescriptionRequiredSchema
projectpathThe project identifierYesstring
taskpathThe task identifierYesstring
Responses
CodeDescription
200The completions returned by the compiler.

/transform/tasks/{project}/{task}

GET

Summary:

Retrieve Transform Task

Parameters
NameLocated inDescriptionRequiredSchema
projectpathThe project identifierYesstring
taskpathThe task identifierYesstring
Responses
CodeDescription
200Success

PUT

Summary:

Update or create a transform task

Parameters
NameLocated inDescriptionRequiredSchema
projectpathThe project identifierYesstring
taskpathThe task identifierYesstring
createOnlyqueryAlways create new transformNoboolean
Responses
CodeDescription
defaultdefault response

DELETE

Summary:

Delete a transform task

Parameters
NameLocated inDescriptionRequiredSchema
projectpathThe project identifierYesstring
taskpathThe task identifierYesstring
removeDependentTasksqueryIf true, transform and linking tasks that directly reference this task are removed as well.Yesboolean
Responses
CodeDescription
defaultdefault response

/transform/tasks/{project}/{task}/rules

GET

Summary:

Retrieve all mapping rules

Description:

Get all mapping rules of the transformation task. If no accept header is defined, XML is returned.

Parameters
NameLocated inDescriptionRequiredSchema
projectpathThe project identifierYesstring
taskpathThe task identifierYesstring
Responses
CodeDescription
200Success

PUT

Summary:

Update all mapping rules

Description:

Update all rules of a transform specification. As for GET XML and JSON are supported. The format for PUT is exactly the same as the result that is returned by a GET request.

Parameters
NameLocated inDescriptionRequiredSchema
projectpathThe project identifierYesstring
taskpathThe task identifierYesstring
Responses
CodeDescription
200The rules were successfully updated. There is no response body.
400If the provided rule serialization is invalid.
404If no rule with the given identifier could be found.

/transform/tasks/{project}/{task}/transformInput

POST

Summary:

Execute transform with payload

Description:

Execute a specific transformation task against input data from the POST body.

Parameters
NameLocated inDescriptionRequiredSchema
projectpathThe project identifierYesstring
taskpathThe task identifierYesstring
Responses
CodeDescription
200If no sink is specified in the request then return results in N-Triples format with the response, else write triples to defined data sink.
404If the specified project or task has not been found.

/transform/tasks/{project}/{task}/peak/{rule}

POST

Summary:

Mapping Rule Transformation Examples

Description:

Get transformation examples for the selected transformation rule. The input task of the transformation task has to be a Dataset task. Also the Dataset task must support this feature.

Parameters
NameLocated inDescriptionRequiredSchema
projectpathThe project identifierYesstring
taskpathThe task identifierYesstring
rulepathThe rule identifierYesstring
limitqueryThe maximum number of transformed example entities.Nointeger
maxTryEntitiesqueryThe maximum number of example entities to try to transform before giving up.Nointeger
Responses
CodeDescription
200The result JSON consists of the actual values, i.e. all source values and all transformed values for each example entity, the source paths of the mapping and a status object. There are as many string arrays in the sourceValues array as there are input paths. Besides 'success' there are 2 other status ids, first there is 'empty' and second 'empty with exceptions'. In both cases the status message gives more details.

/transform/tasks/{project}/{task}/peak/{rule}/childRule

POST

Summary:

Mapping Rule from Request Transformation Examples

Description:

Get transformation examples for the transformation rule that is attached in the body of this request. The input task of the transformation task has to be a Dataset task. Also the Dataset task must support this feature.

Parameters
NameLocated inDescriptionRequiredSchema
projectpathThe project identifierYesstring
taskpathThe task identifierYesstring
rulepathThe rule identifierYesstring
limitqueryThe maximum number of transformed example entities.Nointeger
maxTryEntitiesqueryThe maximum number of example entities to try to transform before giving up.Nointeger
Responses
CodeDescription
200The result JSON consists of the actual values, i.e. all source values and all transformed values for each example entity, the source paths of the mapping and a status object. There are as many string arrays in the sourceValues array as there are input paths. Besides 'success' there are 2 other status ids, first there is 'empty' and second 'empty with exceptions'. In both cases the status message gives more details.

/transform/tasks/{project}/{task}/rule/{rule}

GET

Summary:

Retrieve mapping rule

Description:

Retrieve a single mapping rule from a transform task.

Parameters
NameLocated inDescriptionRequiredSchema
projectpathThe project identifierYesstring
taskpathThe task identifierYesstring
rulepathThe rule identifierYesstring
Responses
CodeDescription
200Success
404If the specified project, task or rule has not been found.

PUT

Summary:

Update mapping rule

Description:

Updates a rule or parts of a rule. The XML and JSON format is the same as returned by the corresponding GET endpoint. For json payloads, the caller may send a fragment that only specifies the parts of the rule that should be updated. The parts that are not sent in the request will remain unchanged.

Parameters
NameLocated inDescriptionRequiredSchema
projectpathThe project identifierYesstring
taskpathThe task identifierYesstring
rulepathThe rule identifierYesstring
Responses
CodeDescription
200Success
400If the provided rule serialization is invalid.
404If the specified project, task or rule has not been found.

DELETE

Summary:

Delete mapping rule

Description:

Delete the rule that is identified by the given id.

Parameters
NameLocated inDescriptionRequiredSchema
projectpathThe project identifierYesstring
taskpathThe task identifierYesstring
rulepathThe rule identifierYesstring
Responses
CodeDescription
200Success
404If the specified project, task or rule has not been found.

/transform/tasks/{project}/{task}/rule/{rule}/rules

POST

Summary:

Append mapping rule

Description:

Appends a new child rule to an object mapping rule.

Parameters
NameLocated inDescriptionRequiredSchema
projectpathThe project identifierYesstring
taskpathThe task identifierYesstring
rulepathThe rule identifierYesstring
afterRuleIdqueryOptional parameter that specified after which existing rule the new rule should be inserted.Nostring
Responses
CodeDescription
200The rule has been updated successfully. The appended rule is returned. In case the caller did not specify an identifier for the appended rule, the result will contain the generated identifier.
400If the provided rule serialization is invalid.
404If the specified project, task or rule has not been found.

/transform/tasks/{project}/{task}/rule/{rule}/valueSourcePaths

GET

Summary:

Mapping Rule Value Source Paths

Description:

Returns an array of string representations of the available source paths.

Parameters
NameLocated inDescriptionRequiredSchema
projectpathThe project identifierYesstring
taskpathThe task identifierYesstring
rulepathThe rule identifierYesstring
maxDepthqueryLimit the depth of the source paths. For example a value of 1 would only return value source paths with exactly one path operator.Nointeger
unusedOnlyqueryIf this is set to true, only source paths that are not used in any rule so far are returned. Considered rules for filtering are only value rules and complex mappings with a single source path.Noboolean
usedOnlyqueryIf this is set to true, only source paths that are already used in any rule so far are returned. Considered rules for filtering are only value rules and complex mappings with a single source path. This must not be true if unusedOnly is true.Noboolean
Responses
CodeDescription
200A list of source paths serialized with prefixed URIs.
404If the specified project, task or rule has not been found.

/transform/tasks/{project}/{task}/rule/{rule}/valueSourcePathsInfo

GET

Summary:

Mapping Rule Value Source Paths Information

Description:

Fetch all value source paths relative to the corresponding rule. Besides the path string that is given in the Silk path language format, additional information about the source path is returned.

Parameters
NameLocated inDescriptionRequiredSchema
projectpathThe project identifierYesstring
taskpathThe task identifierYesstring
rulepathThe rule identifierYesstring
maxDepthqueryLimit the depth of the source paths. For example a value of 1 would only return value source paths with exactly one path operator.Nointeger
objectInfoqueryIf it should return additional information for object paths.Noboolean
Responses
CodeDescription
200A list of source paths with additional information.
404If the specified project, task or rule has not been found.

/transform/tasks/{project}/{task}/rule/{rule}/completions/partialSourcePaths

POST

Summary:

Mapping rule partial source paths

Description:

Returns auto-completion suggestions based on a complex path expression (including backward paths and filters) and the cursor position. The results may only replace a part of the original input string.

Parameters
NameLocated inDescriptionRequiredSchema
projectpathThe project identifierYesstring
taskpathThe task identifierYesstring
rulepathThe rule identifierYesstring
Responses
CodeDescription
200The response contains the original parameters of the request for the client to check to which request it belongs if it fired multiple requests. There can be multiple (or none) suggestion result sections under replacementResults that differ in what part of the original string gets replaced. The replacementInterval specifies the sub-string of the input path string that can be replaced by the proposed partial path suggestions. It is defined by the start index and length of the substring that should be replaced. The extractedQuery property is the query that was extracted from the original input to seed the auto-completion request. This can be empty if the result is not filtered. The replacements contain the suggestions that should be displayed to the user that the specified substring can be replaced with. The value is the actual value of the suggestion and the optional label and description values can be used for a more human-readable version of the value.
404If the specified project, task or rule has not been found.

/transform/tasks/{project}/{task}/rule/{rule}/completions/sourcePaths

GET

Summary:

Mapping rule source paths

Description:

Given a search term, returns all possible completions for source property paths.

Parameters
NameLocated inDescriptionRequiredSchema
projectpathThe project identifierYesstring
taskpathThe task identifierYesstring
rulepathThe rule identifierYesstring
termqueryThe search term. Will also return non-exact matches (e.g., naMe == name) and matches from labels.Nostring
maxResultsqueryThe maximum number of results.Nointeger
Responses
CodeDescription
200Source paths that match the given term
404If the specified project, task or rule has not been found.

/transform/tasks/{project}/{task}/rule/{rule}/completions/targetProperties

GET

Summary:

Mapping rule target properties

Description:

Given a search term, returns possible completions for target properties.

Parameters
NameLocated inDescriptionRequiredSchema
projectpathThe project identifierYesstring
taskpathThe task identifierYesstring
rulepathThe rule identifierYesstring
termqueryThe search term. Will also return non-exact matches (e.g., naMe == name) and matches from labels.Nostring
maxResultsqueryThe maximum number of results.Nointeger
fullUrisqueryReturn full URIs instead of prefixed ones.Noboolean
Responses
CodeDescription
200All properties from the target vocabulary that match the given term.
404If the specified project, task or rule has not been found.

POST

Summary:

Mapping rule target properties

Description:

Given a search term, returns possible completions for target properties. In addition it allows to specify the vocabularies that should be used for auto-completion with the optional vocabularies parameter in the JSON body.

Parameters
NameLocated inDescriptionRequiredSchema
projectpathThe project identifierYesstring
taskpathThe task identifierYesstring
rulepathThe rule identifierYesstring
termqueryThe search term. Will also return non-exact matches (e.g., naMe == name) and matches from labels.Nostring
maxResultsqueryThe maximum number of results.Nointeger
fullUrisqueryReturn full URIs instead of prefixed ones.Noboolean
Responses
CodeDescription
200All properties from the target vocabulary that match the given term.
404If the specified project, task or rule has not been found.

/transform/tasks/{project}/{task}/rule/{rule}/completions/targetTypes

GET

Summary:

Mapping rule target types

Description:

Given a search term, returns possible completions for target types.

Parameters
NameLocated inDescriptionRequiredSchema
projectpathThe project identifierYesstring
taskpathThe task identifierYesstring
rulepathThe rule identifierYesstring
termqueryThe search term. Will also return non-exact matches (e.g., naMe == name) and matches from labels.Nostring
maxResultsqueryThe maximum number of results.Nointeger
Responses
CodeDescription
200All types from the target vocabulary that match the given term.
404If the specified project, task or rule has not been found.

/transform/tasks/{project}/{task}/rule/{rule}/completions/valueTypes

GET

Summary:

Mapping rule value types

Description:

Given a search term, returns possible completions for value types.

Parameters
NameLocated inDescriptionRequiredSchema
projectpathThe project identifierYesstring
taskpathThe task identifierYesstring
rulepathThe rule identifierYesstring
termqueryThe search term. Will also return non-exact matches (e.g., naMe == name) and matches from labels.Nostring
maxResultsqueryThe maximum number of results.Nointeger
Responses
CodeDescription
200All values types that match the given term.
404If the specified project, task or rule has not been found.

/transform/tasks/{project}/{task}/rule/{rule}/rules/copyFrom

POST

Summary:

Copy mapping rule

Description:

Copy a rule from the source transformation task specified by the query parameters and inserts it into the given target transform task specified by the path parameters.

Parameters
NameLocated inDescriptionRequiredSchema
projectpathThe project identifierYesstring
taskpathThe task identifierYesstring
rulepathThe rule identifierYesstring
sourceProjectqueryThe identifier of the source project from the workspace that contains the source transform task from which a rule should be copied from.Yesstring
sourceTaskqueryThe identifier of the source task the rule should be copied from.Yesstring
sourceRulequeryThe identifier of the source rule that should be copied to the target transform task.Yesstring
afterRuleIdqueryOptional parameter that specified after which existing rule the new rule should be inserted.Nostring
Responses
CodeDescription
404If the specified project, task or rule has not been found.

/transform/tasks/{project}/{task}/rule/{rule}/rules/reorder

POST

Summary:

Reorder mapping rules

Description:

Reorder all child rules of an object mapping.

Parameters
NameLocated inDescriptionRequiredSchema
projectpathThe project identifierYesstring
taskpathThe task identifierYesstring
rulepathThe rule identifierYesstring
Responses
CodeDescription
200The rules have been successfully reordered. The new ordered list of rules is returned.
404If the specified project, task or rule has not been found.

/transform/tasks/{project}/{task}/targetVocabulary/propertiesByClass

GET

Summary:

Target vocabulary properties by class

Description:

Get all properties that the given class or any of its parent classes is the domain of in the corresponding target vocabulary.

Parameters
NameLocated inDescriptionRequiredSchema
projectpathThe project identifierYesstring
taskpathThe task identifierYesstring
uriqueryThe URI of the class.Yesstring
Responses
CodeDescription
200Success
404If the specified project, task or class has not been found.

/transform/tasks/{project}/{task}/targetVocabulary/property

GET

Summary:

Target vocabulary property

Description:

Retrieves information about a property from the target vocabularies.

Parameters
NameLocated inDescriptionRequiredSchema
projectpathThe project identifierYesstring
taskpathThe task identifierYesstring
uriqueryThe URI of the property. May be a prefixed name.Yesstring
Responses
CodeDescription
200Target vocabulary property
404If the specified project, task or property has not been found.

/transform/tasks/{project}/{task}/targetVocabulary/relationsOfClass

GET

Summary:

Target vocabulary object properties by class

Description:

Get all direct relations of a class or one of its parent classes to other classes from the vocabulary.

Parameters
NameLocated inDescriptionRequiredSchema
projectpathThe project identifierYesstring
taskpathThe task identifierYesstring
uriqueryThe URI of the class.Yesstring
Responses
CodeDescription
200Success
404If the specified project, task or class has not been found.

/transform/tasks/{project}/{task}/targetVocabulary/type

GET

Summary:

Target vocabulary type

Description:

Retrieves information about a type from the target vocabularies.

Parameters
NameLocated inDescriptionRequiredSchema
projectpathThe project identifierYesstring
taskpathThe task identifierYesstring
uriqueryThe URI of the type. May be a prefixed name.Yesstring
Responses
CodeDescription
200Target vocabulary type
404If the specified project, task or type has not been found.

/transform/tasks/{project}/{task}/targetVocabulary/typeOrProperty

GET

Summary:

Target vocabulary type or property

Description:

Retrieves information about a type or a property from the target vocabularies. This endpoint can be used if it is not known whether the given URI represents a type or a property. Otherwise, the /type and /property endpoints should be prefered.

Parameters
NameLocated inDescriptionRequiredSchema
projectpathThe project identifierYesstring
taskpathThe task identifierYesstring
uriqueryThe URI of the type or property. May be a prefixed name.Yesstring
Responses
CodeDescription
200Target vocabulary type or property
404If the specified project, task has not been found or there is no type or property with the specified URI.

/transform/tasks/{project}/{task}/targetVocabulary/vocabularies

GET

Summary:

Target vocabulary information

Description:

Returns high-level information, e.g. label, class/property statistics, about the accessible vocabularies for that transform task.

Parameters
NameLocated inDescriptionRequiredSchema
projectpathThe project identifierYesstring
taskpathThe task identifierYesstring
Responses
CodeDescription
200Success
404If the specified project or task has not been found.

/workflow/workflows/{project}/{task}/executeOnPayload

POST

Summary:

Execute workflow with request payload

Description:

Execute a variable workflow that gets the inputs for variable data sources with the HTTP request and returns all results of variable data sinks with the HTTP response. This endpoint will block until the workflow execution finished. Use executeOnPayloadAsynchronous for non-blocking execution.

Parameters
NameLocated inDescriptionRequiredSchema
projectpathThe project identifierYesstring
taskpathThe workflow identifierYesstring
Responses
CodeDescription
200Success
404If the specified project or workflow has not been found.

/workflow/workflows/{project}/{task}/executeOnPayloadAsynchronous

POST

Summary:

Execute workflow with request payload asynchronously

Description:

Execute a variable workflow that gets the inputs for variable data sources with the HTTP request and returns all results of variable data sinks with the HTTP response. This endpoint starts the workflow execution in the background and returns the identifier of the started background activity. Use the activity API to query for its exection status and result, e.g., /workspace/projects/{projectId}/tasks/{taskId} /activities/{BackgroundActivityID}/{value or status}. After having consumed the result value a well-behaving client should remove the execution instance via the /execution/{executionId} endpoint.

Parameters
NameLocated inDescriptionRequiredSchema
projectpathThe project identifierYesstring
taskpathThe workflow identifierYesstring
Responses
CodeDescription
201Workflow started.
404If the specified project or workflow has not been found.

/workflow/workflows/{project}/{task}/execution/{executionId}

DELETE

Summary:

Remove a workflow execution instance

Description:

Remove the workflow execution instance, which was started via the /executeOnPayloadAsynchronous endpoint. Since only a limited number of executions are kept at every moment, a well behaving client should remove the execution if the client has consumed the result.",

Parameters
NameLocated inDescriptionRequiredSchema
projectpathThe project identifierYesstring
taskpathThe workflow identifierYesstring
executionIdpathThe execution identifierYesstring
Responses
CodeDescription
200If the execution instance has been removed.
404If the specified project, workflow or execution instance has not been found.

/workspace/marshallingPlugins

GET

Summary:

Marshalling plugins

Description:

Returns a list of supported workspace/project import/export plugins, e.g. RDF, XML.

Responses
CodeDescription
200Success

/workspace/projects

GET

Summary:

List projects

Description:

Get a list with all projects.

Responses
CodeDescription
200Success

/workspace/reload

POST

Summary:

Reload

Description:

Reloads the workspace from the backend. The request blocks until the reload finished.

Responses
CodeDescription
200If the reload succeeded.

/workspace/reloadPrefixes

POST

Summary:

Reload workspace prefixes

Description:

Reloads the workspace prefixes from registered or all vocabularies from the backend. The request blocks until the reload finished.

Responses
CodeDescription
200If the reload succeeded.

/workspace/updateGlobalVocabularyCache

POST

Summary:

Update global vocabulary cache

Description:

Update a specific vocabulary of the global vocabulary cache. This request is non-blocking. It can take a while for the cache to be up to date.

Responses
CodeDescription
204The update of the vocabulary cache has been scheduled.

/workspace/activities/cancel

POST

Summary:

Cancel activity

Description:

Requests cancellation of an activity. The call returns immediately and does not wait until the activity has been cancelled.

Parameters
NameLocated inDescriptionRequiredSchema
projectqueryOptional project identifier. If not provided or empty, global activities will be addressed.Nostring
taskqueryOptional task identifier. If not provided or empty, project activities will be addressed.Nostring
activityqueryActivity name.Yesstring
Responses
CodeDescription
200If the cancellation has been requested successfully.

/workspace/activities/list

GET

Summary:

List activities

Description:

Lists either global, project or task activities.

Parameters
NameLocated inDescriptionRequiredSchema
projectqueryOptional project identifier. If not provided or empty, global activities will be listed.Nostring
taskqueryOptional task identifier. If not provided or empty, project activities will be listed.Nostring
Responses
CodeDescription
200Success

/workspace/activities/start

POST

Summary:

Start activity (non-blocking)

Description:

Starts an activity. The call returns immediately without waiting for the activity to complete.

Parameters
NameLocated inDescriptionRequiredSchema
projectqueryOptional project identifier. If not provided or empty, global activities will be addressed.Nostring
taskqueryOptional task identifier. If not provided or empty, project activities will be addressed.Nostring
activityqueryActivity name.Yesstring
Responses
CodeDescription
200Success

/workspace/activities/startBlocking

POST

Summary:

Start activity (blocking)

Description:

Starts the activity and returns after it has completed.

Parameters
NameLocated inDescriptionRequiredSchema
projectqueryOptional project identifier. If not provided or empty, global activities will be addressed.Nostring
taskqueryOptional task identifier. If not provided or empty, project activities will be addressed.Nostring
activityqueryActivity name.Yesstring
Responses
CodeDescription
200Success

/workspace/activities/status

GET

Summary:

Get activity status

Description:

Retrieves the status of a single activity.

An activity may have the following status names:

  • Idle if the activity has not been started yet.
  • Waiting if the activity has been started and is waiting to be executed.
  • Running if the activity is currently being executed.
  • Canceling if the activity has been requested to stop but has not stopped yet.
  • Finished if the activity has finished execution, either successfully or failed.

Once an activity has been started using the API, the activity transitions to the Waiting status and the isRunning field switches to true. It will remain in Waiting until the execution starts when it transitions to the Running status. If a user cancels the activity during execution, it will transition to Canceling and remain there until it actually stops execution. When the execution finished it transitions to the Finished status and isRunning switches to false. If the activity execution failed, failed will be set to true once the Finished status has been reached.

While running, the progress is tracked by the progress field (0 to 100 percent).

Parameters
NameLocated inDescriptionRequiredSchema
projectqueryOptional project identifier. If not provided or empty, global activities will be addressed.Nostring
taskqueryOptional task identifier. If not provided or empty, project activities will be addressed.Nostring
activityqueryActivity name.Yesstring
Responses
CodeDescription
200Success

/workspace/activities/updates

GET

Summary:

Get activity status updates

Description:

Request updates on the status of one or many activities.

Parameters
NameLocated inDescriptionRequiredSchema
projectqueryOptional project identifier. If empty or not provided, activities from all projects are considered.Nostring
taskqueryOptional task identifier. If empty or not provided, activities from all tasks are considered.Nostring
activityqueryOptional activity identifier. If empty or not provided, updates from all activities that match the task and project are returned.Nostring
timestampqueryOnly return status updates that happened after this timestamp. Provided in milliseconds since midnight, January 1, 1970 UTC. If not provided or 0, the stati of all matching activities are returned.Nostring
Responses
CodeDescription
200Success

/workspace/activities/updatesWebSocket

GET

Summary:

Get activity status updates (websocket)

Description:

Request updates on the status of one or many activities.

Parameters
NameLocated inDescriptionRequiredSchema
projectqueryOptional project identifier. If empty or not provided, activities from all projects are considered.Nostring
taskqueryOptional task identifier. If empty or not provided, activities from all tasks are considered.Nostring
activityqueryOptional activity identifier. If empty or not provided, updates from all activities that match the task and project are returned.Nostring
Responses
CodeDescription
200Success

/workspace/activities/value

GET

Summary:

Get activity value

Description:

Retrieves the current value of this activity, if any.

Parameters
NameLocated inDescriptionRequiredSchema
projectqueryOptional project identifier. If not provided or empty, global activities will be addressed.Nostring
taskqueryOptional task identifier. If not provided or empty, project activities will be addressed.Nostring
activityqueryActivity name.Yesstring
Responses
CodeDescription
200The activity value. The ACCEPT header controls the serialization format (typically JSON or XML).
406No serializer is registered for the requested format.

/workspace/export/{exportPlugin}

GET

Summary:

Export workspace

Description:

Exports the entire workspace with the specified marshalling plugin.

Parameters
NameLocated inDescriptionRequiredSchema
exportPluginpathThe marshalling format. One of the ids returned from the marshallingPlugins endpoint.Yesstring
Responses
CodeDescription
200The response contains the exported workspace.

/workspace/import/{importPlugin}

POST

Summary:

Import workspace

Description:

Imports the entire workspace from the file send with the request. Before importing all existing projects will be removed from the workspace.

Parameters
NameLocated inDescriptionRequiredSchema
importPluginpathThe marshalling format. One of the ids returned from the marshallingPlugins endpoint.Yesstring
Responses
CodeDescription
200If the import succeeded

/workspace/projects/{project}

GET

Summary:

Get project contents

Description:

List the contents of a single project.

Parameters
NameLocated inDescriptionRequiredSchema
projectpathThe project identifierYesstring
Responses
CodeDescription
200Success
404If the project has not been found.

PUT

Summary:

Create project

Description:

Create a new empty project.

Parameters
NameLocated inDescriptionRequiredSchema
projectpathThe project identifierYesstring
Responses
CodeDescription
201Success
409If a project with the specified identifier already exists.

DELETE

Summary:

Delete project

Description:

Delete a project.

Parameters
NameLocated inDescriptionRequiredSchema
projectpathThe project identifierYesstring
Responses
CodeDescription
200If the project has been deleted successfully.
404If the project has not been found.

/workspace/projects/{project}/clone

POST

Summary:

Clone project

Description:

Clone a project.

Parameters
NameLocated inDescriptionRequiredSchema
projectpathThe identifier of the source project, which is to be cloned.Yesstring
newProjectqueryThe identifier of the cloned project.Yesstring
Responses
CodeDescription
200If the project has been cloned successfully.
404If the source project has not been found.

/workspace/projects/{project}/copy

POST

Summary:

Copy project tasks

Description:

Copies all tasks in a project to another project. Referenced resources are copied only if the target project uses a different resource path than the source project.

Parameters
NameLocated inDescriptionRequiredSchema
projectpathThe project identifier.Yesstring
Responses
CodeDescription
200Lists all copied tasks.
404If the project has not been found.

/workspace/projects/{project}/resources

GET

Summary:

List project resources

Description:

Lists all resources available to a specific project. Resources of a project are for example files used as input or output.

Parameters
NameLocated inDescriptionRequiredSchema
projectpathThe project identifierYesstring
searchTextqueryIf defined the resources will be filtered by the search text which searches over the resource names.Nostring
limitqueryLimits the number of resources returned by this endpoint.Nointeger
offsetqueryThe offset in the result list. Offset and limit allow paging over the results.Nointeger
Responses
CodeDescription
200Success
404If the specified project has not been found.

/workspace/projects/{project}/tasks

POST

Summary:

Add task

Description:

Add a new task to the project. If the 'id' parameter is omitted in the request, an ID will be generated from the label – which is then required.

Parameters
NameLocated inDescriptionRequiredSchema
projectpathThe project identifierYesstring
Responses
CodeDescription
201The added task.
400If the provided task specification is invalid.
404If the project does not exist.
409If a task with the given identifier already exists.

/workspace/projects/{project}/datasets/{name}

GET

Summary:

Retrieve dataset

Description:

Retrieve the specification of a dataset.

Parameters
NameLocated inDescriptionRequiredSchema
projectpathThe project identifierYesstring
namepathThe dataset identifierYesstring
Responses
CodeDescription
200Success
404If the specified project or dataset has not been found.

PUT

Summary:

Create or update dataset

Description:

Create or update a dataset.

Parameters
NameLocated inDescriptionRequiredSchema
projectpathThe project identifierYesstring
namepathThe dataset identifierYesstring
autoConfigurequeryIf true, the dataset parameters will be auto configured. Only works with dataset plugins that support auto configuration, e.g., CSV.Noboolean
Responses
CodeDescription
204If the dataset has been created or updated.
400If the provided dataset specification is invalid.
404If the specified project has not been found.

DELETE

Summary:

Delete dataset

Description:

Remove a dataset from a project.

Parameters
NameLocated inDescriptionRequiredSchema
projectpathThe project identifierYesstring
namepathThe dataset identifierYesstring
Responses
CodeDescription
204If the dataset has been deleted or there is no dataset with that identifier.
404If the specified project has not been found.

/workspace/projects/{project}/datasets/{name}/autoConfigured

GET

Summary:

Auto-configure dataset

Description:

Retrieve an auto-configured version of the dataset.

Parameters
NameLocated inDescriptionRequiredSchema
projectpathThe project identifierYesstring
namepathThe dataset identifierYesstring
Responses
CodeDescription
200Success
400If the dataset type does not support auto-configuration.
404If the specified project or dataset has not been found.

/workspace/projects/{project}/datasets/{name}/mappingCoverage

GET

Summary:

Dataset mapping coverage

Description:

Returns the mapping coverage of a this dataset. The mapping coverage is derived from all transformations from the same project that have this dataset as input. It has three categories, fully mapped, partially mapped and unmapped. A source path is fully mapped if it only consists of forward paths and no backward paths or filters. If there are filters or backward paths then it can maximally be considered as partially mapped, although in reality several partial mappings could fully cover a path. The algorithm cannot detect such kind of combined coverage. A path is unmapped if it is not uses as value input in any mapping.

Parameters
NameLocated inDescriptionRequiredSchema
typequeryThis optional parameter specifies which coverage types should be returned. This is a comma-separated String. Allowed values are 'fullyMapped', 'partiallyMapped' and 'unmapped'. Default is all types.Nostring
projectpathThe project identifierYesstring
namepathThe dataset identifierYesstring
Responses
CodeDescription
200Success
404If the specified project or dataset has not been found.
500If the dataset type does not support mapping coverage.

/workspace/projects/{project}/datasets/{name}/types

GET

Summary:

Dataset types

Description:

Get a list of entity types of this dataset. Types of a dataset can be classes of an ontology or in the case of a CSV file, a single type.

Parameters
NameLocated inDescriptionRequiredSchema
projectpathThe project identifierYesstring
namepathThe dataset identifierYesstring
textQueryqueryAn optional multi-word text query to filter the types by.Nostring
limitqueryReturns max. that many types in the result. If not specified all types are returned.Nointeger
Responses
CodeDescription
200Success
404If the specified project has not been found.
500If loading types from the dataset failed.

/workspace/projects/{project}/datasets/{name}/mappingCoverage/values

POST

Summary:

Dataset source path mapping coverage

Description:

Returns mapping value coverage details for a specific dataset path. This is mostly relevant for partially mapped paths. It takes a specific path as input and returns the number of values found at this path, the number of values actually used by all mapping of the project and values that are not covered.

Parameters
NameLocated inDescriptionRequiredSchema
projectpathThe project identifierYesstring
namepathThe dataset identifierYesstring
Responses
CodeDescription
200Success
404If the specified project or dataset has not been found.
500If the dataset type does not support mapping coverage.

/workspace/projects/{project}/export/{exportPlugin}

GET

Summary:

Export project

Description:

Export a project with the specified marshalling plugin.

Parameters
NameLocated inDescriptionRequiredSchema
projectpathThe project identifierYesstring
exportPluginpathThe marshalling format. One of the ids returned from the marshallingPlugins endpoint.Yesstring
Responses
CodeDescription
200The response contains the exported project.

/workspace/projects/{project}/import/{importPlugin}

POST

Summary:

Import project

Description:

Import a project from the file send with the request.

Parameters
NameLocated inDescriptionRequiredSchema
projectpathThe project identifierYesstring
importPluginpathThe marshalling format. One of the ids returned from the marshallingPlugins endpoint.Yesstring
Responses
CodeDescription
200If the import succeeded

/workspace/projects/{project}/resources/{name}

GET

Summary:

Retrieve resource

Description:

Retrieve the contents of a resource.

Parameters
NameLocated inDescriptionRequiredSchema
projectpathThe project identifierYesstring
namepathThe resourceYesstring
Responses
CodeDescription
404If the specified project or resource has not been found.

PUT

Summary:

Upload resource

Description:

Adds a file from the local file system to the project. There are three options to upload files:

  1. Providing a local resource using the file form parameter.
  2. Providing a remote resource using the resource-url form parameter. The provided resource will be downloaded and added to the project.
  3. Providing the file as body payload. Supplying no body will create an empty resource.

The options are exclusive, i.e., only one option can be used per request.

Parameters
NameLocated inDescriptionRequiredSchema
projectpathThe project identifierYesstring
namepathThe resourceYesstring
Responses
CodeDescription
204If the resource has been uploaded successfully.
404If the specified project or resource has not been found.

DELETE

Summary:

Delete resource

Description:

If the resource exists, delete it.

Parameters
NameLocated inDescriptionRequiredSchema
projectpathThe project identifierYesstring
namepathThe resourceYesstring
Responses
CodeDescription
204If the resource has been deleted. Also returns 204 if the resource does not exist.
404If the specified project has not been found.

/workspace/projects/{project}/resources/{name}/metadata

GET

Summary:

Retrieve resource metadata

Description:

Retrieve the properties of a specific resource.

Parameters
NameLocated inDescriptionRequiredSchema
projectpathThe project identifierYesstring
namepathThe resourceYesstring
Responses
CodeDescription
200Success
404If the specified project or resource has not been found.

/workspace/projects/{project}/resources/{name}/usage

GET

Summary:

Resource usage

Description:

Returns a list of datasets/tasks that are using the specified resource.

Parameters
NameLocated inDescriptionRequiredSchema
projectpathThe project identifierYesstring
namepathThe resourceYesstring
Responses
CodeDescription
200Success
404If the specified project or resource has not been found.

/workspace/projects/{project}/tasks/{task}

GET

Summary:

Retrieve task

Description:

Retrieve a task from a project.

Parameters
NameLocated inDescriptionRequiredSchema
projectpathThe project identifierYesstring
taskpathThe task identifierYesstring
withLabelsqueryIf true, all parameter values will be reified in a new object that has an optional label property. A label is added for all auto-completable parameters that have the 'autoCompleteValueWithLabels' property set to true. This guarantees that a user always sees the label of such values. For object type parameters that have set the 'visibleInDialog' flag set to true, this reification is done on all levels. For object type parameters that should not be shown in UI dialogs this is still done for the first level of the task itself, but not deeper. These values should never be set or updated by a normal UI dialog anyway and should be ignored by a task dialog.Noboolean
Responses
CodeDescription
200The task.
404If the project or task does not exist.

PUT

Summary:

Add or update task

Description:

Add or update a task.

Parameters
NameLocated inDescriptionRequiredSchema
projectpathThe project identifierYesstring
taskpathThe task identifierYesstring
Responses
CodeDescription
200If the task has been added or updated successfully.
400If the provided task specification is invalid.
404If the project does not exist.

DELETE

Summary:

Delete task

Description:

Remove a task from a project.

Parameters
NameLocated inDescriptionRequiredSchema
projectpathThe project identifierYesstring
taskpathThe task identifierYesstring
removeDependentTasksqueryIf true, all tasks that directly or indirectly reference this task are removed as well.Yesboolean
Responses
CodeDescription
200If the task has been deleted or there is no task with that identifier.
404If the project does not exist.

PATCH

Summary:

Update task

Description:

Update selected properties of a task. Only the sent JSON paths will be updated, i.e., the provided JSON is deep merged into the existing task JSON.

Parameters
NameLocated inDescriptionRequiredSchema
projectpathThe project identifierYesstring
taskpathThe task identifierYesstring
Responses
CodeDescription
200If the task has been updated successfully.
400If the provided task specification is invalid.
404If the project or task does not exist.

/workspace/projects/{project}/tasks/{task}/clone

POST

Summary:

Clone Task

Description:

Clone a task.

Parameters
NameLocated inDescriptionRequiredSchema
projectpathThe project identifierYesstring
taskpathThe identifier of the task to be clonedYesstring
newTaskqueryThe new task identifierYesstring
Responses
CodeDescription
200If the has been cloned.
404If the project or task does not exist.

/workspace/projects/{project}/tasks/{task}/copy

POST

Summary:

Copy Task to Another Project

Description:

Copies a task to another project. All tasks that the copied task references (directly or indirectly) are copied as well. Referenced resources are copied only if the target project uses a different resource path than the source project. Using the dryRun attribute, a copy operation can be simulated, i.e., the response listing the tasks to be copied and overwritten can be checked first.

Parameters
NameLocated inDescriptionRequiredSchema
projectpathThe project identifierYesstring
taskpathThe task identifierYesstring
Responses
CodeDescription
200If the has been copied.
404If the project or task does not exist.

/workspace/projects/{project}/tasks/{task}/downloadOutput

GET

Summary:

Task output

Description:

Downloads the contents of the first output dataset of the specified task. Note that this does not execute the task, but assumes that it has been executed already. The output dataset must be file based.

Parameters
NameLocated inDescriptionRequiredSchema
projectpathThe project identifierYesstring
taskpathThe task identifierYesstring
Responses
CodeDescription
200The task output.
400If the output could not be downloaded. The reason is stated in the response body.
404If the project or task does not exist.

/workspace/projects/{project}/tasks/{task}/metadata

GET

Summary:

Retrieve task metadata

Description:

Retrieve task metadata that includes user metadata, such as the task label as well as technical metadata, such as the referenced tasks.

Parameters
NameLocated inDescriptionRequiredSchema
projectpathThe project identifierYesstring
taskpathThe task identifierYesstring
Responses
CodeDescription
200The task metadata
404If the project or task does not exist.

PUT

Summary:

Update task metadata

Description:

Updates task metadata that includes user metadata, such as the task label as well as technical metadata, such as the referenced tasks.

Parameters
NameLocated inDescriptionRequiredSchema
projectpathThe project identifierYesstring
taskpathThe task identifierYesstring
Responses
CodeDescription
200If the task metadata has been updated successfully.
404If the project or task does not exist.

Models

DataIntegrationHealthDetails

NameTypeDescriptionRequired
dataPlatformHealthIndicatorDataPlatformHealthIndicator No
sparkHealthIndicatorSparkHealthIndicator No

DataIntegrationHealthIndicator

NameTypeDescriptionRequired
statusstring Yes
detailsDataIntegrationHealthDetails Yes

DataPlatformHealthCheck

NameTypeDescriptionRequired
healthEndpointstring Yes
statusCodeobject No
errorMessagestring No
statusstring No
downboolean Yes

DataPlatformHealthDetails

NameTypeDescriptionRequired
dataPlatformUrlstring Yes
oAuthEnabledobject No
tokenUrlstring No
authorizationUrlstring No
dataPlatformHealthCheckDataPlatformHealthCheck No

DataPlatformHealthIndicator

NameTypeDescriptionRequired
statusstring Yes
detailsDataPlatformHealthDetails Yes

SparkHealthDetails

NameTypeDescriptionRequired
sparkContextStartsboolean Yes
errorMessagestring No
appNamestring No
startTimeobject No

SparkHealthIndicator

NameTypeDescriptionRequired
statusstring Yes
detailsSparkHealthDetails Yes

ActionAnyContent

NameTypeDescriptionRequired
ActionAnyContentobject

MatchTargetClassToSourceDatasetRequest

NameTypeDescriptionRequired
projectNamestringThe project name of the dataset and transformation task.Yes
transformTaskNamestringThe transformation task where the target vocabularies are taken from, in which the target class must be contained.Yes
targetClassUris[ string ] No
dataTypePropertiesOnlybooleanIf set to true, only data type properties from the vocabulary are matched.No
nrCandidatesintegerThe max. number of matching candidates per property/path.No
uriPrefixstringThis URI prefix is prepended to generated URIs during the schema extraction process. If not specified a dummy URI prefix is used.No
ruleIdstringRule Id.No
schemaExtractionTimeLimitlongSchema extraction time limit.No
schemaEntityLimitintegerSchema entity limit.No
matchFromDatasetbooleanSpecifies if the dataset or the vocabulary is considered the source in the matching process. If set to true there are nrCandidates vocabulary properties matched to each dataset source path,No
addMetaDatabooleanAdd metadata or not.No
targetVocabularies[ string ] No

MatchTargetClassToSourceDatasetResponse

NameTypeDescriptionRequired
matches[ MatchingSuggestion ] No

MatchingCandidate

NameTypeDescriptionRequired
uristringThe URI of the candidate entity.No
confidencedoubleThe confidence value, should only be used for ranking, ordinal scale.Yes
typestringThe type of the proposed mapping rule.Yes
labelstringAn optional label of the property.No
descriptionstringAn optional description of the property.No
graphstringOptional graph the resource was loaded from. Usually only set for properties loaded from the DP.No

MatchingSuggestion

NameTypeDescriptionRequired
uristringThe source URI or source path.Yes
labelstringAn optional label. Usually only available when matching from vocabulary side.No
descriptionstringAn optional description. Usually only available when matching from vocabulary side..No
graphstringOptional graph the resource was loaded from. Usually only set for properties loaded from the DP.No
candidates[ MatchingCandidate ] No

ActionJsValue

NameTypeDescriptionRequired
ActionJsValueobject

Correspondence

Set of Correspondences.

NameTypeDescriptionRequired
sourcePathstringSource path.Yes
targetPropertystringThe target property.No
typestringType of the correspondenceYes

GenerateRuleBasedOnProfilingRequest

NameTypeDescriptionRequired
correspondences[ Correspondence ] No
sampleLimitintegerSample Limit.No
uriPrefixstringURI prefix.No
addRulesbooleanAdd rules or not.No

ValidationResult

Result of a validation of an OpenAPI specification.

NameTypeDescriptionRequired
messages[ string ] No

DatasetRequest

NameTypeDescriptionRequired
projectstring Yes
datasetstring Yes
typeUristring No

Column

The primary key Column

NameTypeDescriptionRequired
datasetstring Yes
typeUristring Yes
pathstring Yes

ValidateForeignKeyRequest

NameTypeDescriptionRequired
projectstringThe project identifierYes
primaryKeyColumn Yes
foreignKeyColumn Yes

ValidatePrimaryKeyRequest

NameTypeDescriptionRequired
projectstringThe project identifierYes
primaryKeyColumn Yes

EntitySampleLimits

The entity example limit

NameTypeDescriptionRequired
dataTypeDetectioninteger Yes
profilingobject No

ProfileDataSetTypeRequest

NameTypeDescriptionRequired
sourceTypestringThe source type of the datasetYes
datasetUristringThe URI of the datasetNo
uriPrefixstringThe URI prefix of the datasetNo
entitySampleLimitsEntitySampleLimits No

ItemCloneRequest

NameTypeDescriptionRequired
metaDataItemMetaData Yes

ItemMetaData

NameTypeDescriptionRequired
labelstring Yes
descriptionstring No

ItemCloneResponse

NameTypeDescriptionRequired
idstring Yes
detailsPagestring Yes

ProjectCreationData

NameTypeDescriptionRequired
metaDataItemMetaData Yes

CompletionRequest

NameTypeDescriptionRequired
linestring Yes
columninteger Yes

PartialSourcePathAutoCompletionRequest

NameTypeDescriptionRequired
inputStringstring Yes
cursorPositioninteger Yes
maxSuggestionsobject No
inBackwardOpboolean Yes
inExplicitForwardOpboolean No

CompletionBase

NameTypeDescriptionRequired
valuestring Yes
labelstring No
descriptionstring No

PartialSourcePathAutoCompletionResponse

NameTypeDescriptionRequired
inputStringstring Yes
cursorPositioninteger Yes
replacementResults[ ReplacementResults ] No

ReplacementInterval

NameTypeDescriptionRequired
frominteger Yes
lengthinteger Yes

ReplacementResults

NameTypeDescriptionRequired
replacementIntervalReplacementInterval Yes
extractedQuerystring Yes
replacements[ CompletionBase ] No

Completion

NameTypeDescriptionRequired
valuestringThe value to be filled if the user selects this completion.Yes
confidencedoubleThe confidence of this completion.Yes
labelstringA user readable label if available.No
descriptionstringA user readable description if available.No
categorystringThe category to be shown in the autocompletion.Yes
isCompletionbooleanTrue, if this is a valid completion. False, if this is a (error) message.Yes
extraobjectSome extra values depending on the category (arbitrary JSON)No

Completions

List of auto completions

NameTypeDescriptionRequired
values[ Completion ] No

SeqString

NameTypeDescriptionRequired

TargetPropertyAutoCompleteRequest

NameTypeDescriptionRequired
vocabularies[ string ] Yes

ObjectValueSourcePathInfo

Added when the objectInfo query parameters has been enabled and the path is of type 'object'.

NameTypeDescriptionRequired
dataTypeSubPaths[ string ]Direct value paths, i.e. of all direct sub-paths of length 1 of the object values of the path.No
objectSubPaths[ string ]Direct object paths, i.e. of all direct sub-paths of length 1 of the object values of the path.No

ValueSourcePathInfo

NameTypeDescriptionRequired
pathstringSerialized path representationNo
pathTypestringEither 'value' or 'object' depending the type of values the path points atNo
alreadyMappedbooleanSignals if this path is already in use by another mapping rule in the same transformation.No
objectInfoObjectValueSourcePathInfo No

WebSocket

NameTypeDescriptionRequired
WebSocketobject

ActivityInstance

An activity instance.

NameTypeDescriptionRequired
idstringThe identifier of the activity instance.No

ActivityListEntry

An activity and all of its instances. Non-singleton activities may have multiple parallel instances while singleton instances always have one instance.

NameTypeDescriptionRequired
namestringThe name of the activity.No
instances[ ActivityInstance ] No

StartActivityResponse

NameTypeDescriptionRequired
activityIdstring Yes

MappingValueCoverageRequest

NameTypeDescriptionRequired
dataSourcePathstring Yes

FileMultiPartRequest

NameTypeDescriptionRequired
filebinaryResource contentsNo

ResourceMultiPartRequest

NameTypeDescriptionRequired
filebinaryResource contentsNo
resource-urlstringResource URLNo

CopyTasksRequest

NameTypeDescriptionRequired
dryRunobjectIf true, the copy operation will be simulated, i.e., the response listing the tasks to be copied and overwritten can be checked first.No
overwriteTasksobjectIf true, tasks in the target project will be overwritten.No
targetProjectstringThe identifier of the target project.No

CopyTasksResponse

NameTypeDescriptionRequired
copiedTasks[ TaskToBeCopied ] Yes
overwrittenTasks[ TaskToBeCopied ] Yes

SetTaskToBeCopied

NameTypeDescriptionRequired

TaskToBeCopied

NameTypeDescriptionRequired
taskTypestring Yes
idstring Yes
labelstring Yes
originalTaskLinkstring Yes
overwrittenTaskLinkstring No

UpdateGlobalVocabularyRequest

NameTypeDescriptionRequired
iristring Yes

FacetSetting

Defines what facets are set to which values. The 'keyword' facet allows multiple values to be set.

NameTypeDescriptionRequired
FacetSettingobjectDefines what facets are set to which values. The 'keyword' facet allows multiple values to be set.

FacetedSearchRequest

NameTypeDescriptionRequired
projectstringIf defined, only artifacts from that project are fetched.No
itemTypestringIf defined, only artifacts of this type are fetched.No
textQuerystringConjunctive multi word query. The single words can be scattered over different artifact properties, e.g. one in label and one in description.No
offsetintegerSearch result offset to allow for paging.No
limitintegerSearch result limit to allow for paging. Can be disabled by setting it to '0', which will return all results.No
sortByValue No
sortOrderValue No
facets[ FacetSetting ]Defines what facets are set to which values. The 'keyword' facet allows multiple values to be set.No

SeqFacetSetting

Defines what facets are set to which values. The 'keyword' facet allows multiple values to be set.

NameTypeDescriptionRequired

Value

If defined, only artifacts from that project are fetched.

NameTypeDescriptionRequired
ValueobjectIf defined, only artifacts from that project are fetched.

FacetResult

NameTypeDescriptionRequired
idstring Yes
labelstring Yes
descriptionstring Yes
typestring Yes
values[ FacetValue ] No

FacetValue

NameTypeDescriptionRequired
FacetValueobject

FacetedSearchResult

The result list as well as the list of potential facets for the currently selected task type.

NameTypeDescriptionRequired
totalinteger Yes
results[ object ] No
sortByProperties[ SortableProperty ] No
facets[ FacetResult ] No

SortableProperty

NameTypeDescriptionRequired
idstring Yes
labelstring Yes

ParameterAutoCompletionRequest

NameTypeDescriptionRequired
pluginIdstring Yes
parameterIdstring Yes
projectIdstring Yes
dependsOnParameterValues[ string ] Yes
textQuerystring No
offsetobject No
limitobject No

SearchRequest

NameTypeDescriptionRequired
projectstringRestrict search to a specific project.No
searchTermstringOnly return tasks that match a search term. Currently, the search covers the ID, the label, the description and the task properties.No
formatOptionsTaskFormatOptions No

TaskFormatOptions

The format options specify which parts are to be included in the response.

NameTypeDescriptionRequired
includeMetaDatabooleanInclude the task meta data.No
includeTaskDatabooleanInclude the task data.No
includeTaskPropertiesbooleanRetrieves a list of properties as key-value pairs to be displayed to the user.No
includeRelationsbooleanInclude relations to other tasks.No
includeSchematabooleanInclude the input and output schemata of the task.No

SourcePathValidationRequest

NameTypeDescriptionRequired
pathExpressionstring Yes

PartialParseError

NameTypeDescriptionRequired
offsetinteger Yes
messagestring Yes
inputLeadingToErrorstring Yes
nextParseOffsetinteger Yes

SourcePathValidationResponse

NameTypeDescriptionRequired
validboolean Yes
parseErrorPartialParseError No