Skip to main content

Get help for ARIS Process Mining functions and services

Update a source table definition

Updates a source table definition, but leaves the existing data unchanged. It can be used to

  • change the fully qualified name, namespace, and/or name.

    Note that "_ARIS" is not allowed as a namespace.

  • change the table type from regular table to incremental.

  • (re-)define a merge key for an incremental table.

  • Add columns to an incremental table.

  • Configure the schema of subsequent data deliveries to no longer contain particular columns. Existing data will still include the column.

    Columns of a regular table cannot be changed with this method. Use the Create or replace source tables endpoint instead.

POST /api/pub/dataIngestion/v1/dataSets/{dataSet}/sourceTables/{sourceTable}/definition

Input:

SourceTableDefinition object

  • The source table must already exist.

    • Existing data is preserved.

    • Therefore, not all changes to the definition are permitted.

    • The source table in the URL can either be a key or a fully qualified name.

    • All properties of the source table definition are optional. If the properties are not set, the values of the existing table are reused.

      Note the following.

      The columns of a table will be set as a whole, that is, to remove a column just omit it from the body. To add a column, repeat the information of the existing columns and include the new column.

      If both fully qualified name and name and/or namespace are provided in the body, the fully qualified name takes precedence.

Output:

List of SourceTableDefinition objects based on newly created or replaced source tables

Note that updating the data of an incremental table can involve changes to the schema of the source table.