API docs by Redocly

Inverbis Analytics API (v0)

Download OpenAPI specification:

Exploration - Views

/v0/{tenant}/dashboard/graph

path Parameters
tenant
required
string

Customer environment name

header Parameters
Accept-Language
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
required
datasetUid
string or null
graphType
required
string (GraphType)
Enum: "ATTRIBUTE" "SCATTER" "BAR" "HEATMAP" "FREQUENCY_AND_DURATION"
graphGroup
required
string (GraphGroup)
Enum: "ATTRIBUTE" "VARIANTS" "ACTIVITIES" "TRANSITIONS" "OTHERS"
required
Array of objects or null (InputFilterDTO)
required
Array of objects or null (InputFilterDTO)
required
Array of objects or null (InputFilterDTO)
filterSets
Array of strings or null

Responses

Request samples

Content type
application/json
{
  • "datasetUid": "string",
  • "graphType": "ATTRIBUTE",
  • "graphGroup": "ATTRIBUTE",
  • "generalFilters": [
    ],
  • "dashboardFilters": [
    ],
  • "ownFilters": [
    ],
  • "filterSets": [
    ]
}

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "errorMessage": "string",
  • "additionalInfo": [
    ]
}

Returns a list of activities sorted by some criteria

Activities sorted

This endpoint allows to retrieve the list of process activities present in a dataset sorted by certain criteria.

The currently supported criteria are the following:

  • FREQUENCY: This criteria sorts the activity by the number of times this activity appears on the traces.
  • DURATION_AVG: This criteria sorts the activities by the AVERAGE duration time or lead time of the underlying traces
  • DURATION_MIN: This criteria sorts the activities by the MINIMUM duration time or lead time of the underlying traces
  • DURATION_MAX: This criteria sorts the activities by the MAXIMUM duration time or lead time of the underlying traces
  • DURATION_STD: This criteria sorts the activities by the STANDARD DEVIATION of the duration time or lead time of the underlying traces.

Because the service returns a subset of the activities, a top N, it is possible to choose the sorting direction. This means that for example in case of the frequency, these feature will allow to retrieve the top N most frequent or less frequent.

path Parameters
tenant
required
string

Customer environment name

header Parameters
Accept-Language
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
required
datasetUid
string or null
limit
integer or null <int32>
sortBy
string or null
sortDirection
string or null
required
Array of objects or null (InputFilterDTO)
filterSets
required
Array of strings or null

Responses

Request samples

Content type
application/json
{
  • "datasetUid": "string",
  • "limit": 0,
  • "sortBy": "string",
  • "sortDirection": "string",
  • "filters": [
    ],
  • "filterSets": [
    ]
}

Response samples

Content type
application/json
{
  • "rows": [
    ]
}

Returns a list of transitions sorted by some criteria

Transitions sorted

This endpoint allows to retrieve the list of process variants present in a dataset sorted by certain criteria.

The currently supported criteria are the following:

  • FREQUENCY: This criteria sorts the transitions based on their number of executions present in the dataset traces.
  • DURATION_AVG: This criteria sorts the transitions by the AVERAGE duration time or lead time of the underlying transitions within the traces.
  • DURATION_MIN: This criteria sorts the transitions by the MIN duration time or lead time of the underlying transitions within the traces.
  • DURATION_MAX: This criteria sorts the transitions by the MAX duration time or lead time of the underlying transitions within the traces.
  • DURATION_STD: This criteria sorts the transitions by the STANDARD DEVIATION duration time or lead time of the underlying transitions within the traces.

Because the service returns a subset of the variants, a top N, it is possible to choose the sorting direction. This means that for example in case of the frequency, these feature will allow to retrieve the top N most frequent or less frequent.

path Parameters
tenant
required
string

Customer environment name

header Parameters
Accept-Language
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
required
datasetUid
string or null
limit
integer or null <int32>
sortBy
string or null
sortDirection
string or null
required
Array of objects or null (InputFilterDTO)
filterSets
required
Array of strings or null

Responses

Request samples

Content type
application/json
{
  • "datasetUid": "string",
  • "limit": 0,
  • "sortBy": "string",
  • "sortDirection": "string",
  • "filters": [
    ],
  • "filterSets": [
    ]
}

Response samples

Content type
application/json
{
  • "rows": [
    ]
}

Returns a list of variants comparing various dimensions and sorted by the first one

Variants Over

This endpoint allows to retrieve the list of process variants present in a dataset while comparing more than one dimension of the associated attributes. For example it is possible to retrieve the list of the top ten most frequent variants over the average duration dimension, this means that the response will contain the top N variants sorted by its frequency and an additional dimension corresponding to the average duration of each variant.

path Parameters
tenant
required
string

Customer environment name

header Parameters
Accept-Language
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
required
datasetUid
string or null
limit
integer or null <int32>
object
required
Array of objects or null (VariantsOverQueryDimension)
sortDirection
string or null
required
Array of objects or null (InputFilterDTO)

Responses

Request samples

Content type
application/json
{
  • "datasetUid": "string",
  • "limit": 0,
  • "baseDimension": {
    },
  • "additionalDimensions": [
    ],
  • "sortDirection": "string",
  • "filters": [
    ]
}

Response samples

Content type
application/json
{
  • "rows": [
    ]
}

Returns a list of variants sorted by some criteria

Variants sorted

This endpoint allows to retrieve the list of process variants present in a dataset sorted by certain criteria.

The currently supported criteria are the following:

  • FREQUENCY: This criteria sorts the variants by the number of traces that belong to the variant present in the dataset or filtered dataset if the some filters are provided.
  • DURATION_AVG: This criteria sorts the variants by the AVERAGE duration time or lead time of the underlying traces that conform the variant model.
  • DURATION_MIN: This criteria sorts the variants by the MINIMUM duration time or lead time of the underlying traces that conform the variant model.
  • DURATION_MAX: This criteria sorts the variants by the MAXIMUM duration time or lead time of the underlying traces that conform the variant model.
  • DURATION_STD: This criteria sorts the variants by the STANDARD DEVIATION of the duration time or lead time of the underlying traces that conform the variant model.

Because the service returns a subset of the variants, a top N, it is possible to choose the sorting direction. This means that for example in case of the frequency, these feature will allow to retrieve the top N most frequent or less frequent.

path Parameters
tenant
required
string

Customer environment name

header Parameters
Accept-Language
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
required
datasetUid
string or null
limit
integer or null <int32>
sortBy
string or null
sortDirection
string or null
required
Array of objects or null (InputFilterDTO)
filterSets
required
Array of strings or null

Responses

Request samples

Content type
application/json
{
  • "datasetUid": "string",
  • "limit": 0,
  • "sortBy": "string",
  • "sortDirection": "string",
  • "filters": [
    ],
  • "filterSets": [
    ]
}

Response samples

Content type
application/json
{
  • "rows": [
    ]
}

Management - Datasets

Retrieve datasets for a given project

This endpoint retrieves datasets of a specific project, specified by project UUID as a query param. The service allows pagination, text search by dataset name and filtering archived datasets.

path Parameters
tenant
required
string

Customer environment name

query Parameters
includeArchived
boolean

Include archived datasets

limit
integer <int32>

Page size for pagination

projectUid
required
string

Project UID

search
string

Filter by dataset's name (partial and case insensitive)

sortBy
string

Sort direction: ASCENDING of DESCENDING

sortDirection
string

Sort direction: ASCENDING of DESCENDING

start
integer <int32>

Page index for pagination

header Parameters
Accept-Language
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "data": [
    ]
}

Register a new dataset associated with a project

Attempts to create a new dataset associated with a specific project. The user must have access to the organization and must not have reached the event limit. If succeeded, the service returns the UUID of the newly created dataset in the X-Location-uid header.

This service only requires basic information such as name and description. To complete the upload process one must call /uploads/{datasetUid} and /datasets/{datasetUid}/configurations with the provided UUID.

path Parameters
tenant
required
string

Customer environment name

header Parameters
Accept-Language
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
required
name
required
string [ 5 .. 100 ] characters
description
string or null [ 0 .. 500 ] characters
projectUid
required
string^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}...

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "projectUid": "string"
}

Response samples

Content type
application/json
{ }

Retrieves the collection of filters available

This endpoint returns all available definitions for input filters [FilterDTO]. These filters can be used to configure several [InputFilterDTO] and pass them to any service that allows this kind of filtering. Available filters:

  • TRACE_STARTS_WITH_ACTIVITY
  • TRACE_ENDS_WITH_ACTIVITY
  • TRACE_CONTAINS_ACTIVITIES
  • TRACE_NOT_CONTAINS_ACTIVITIES
  • TRACE_STARTS_BEFORE
  • TRACE_ENDS_BEFORE
  • TRACE_STARTS_AFTER
  • TRACE_ENDS_AFTER
  • TRACE_DURATION_GREATER_THAN
  • TRACE_DURATION_LESS_THAN
  • TRACE_IS_IN_VARIANTS
  • TRACE_IS_IN_LOOP_VARIANTS
  • TRACE_IS_IN_N_VARIANTS
path Parameters
tenant
required
string

Customer environment name

header Parameters
Accept-Language
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieves the collection of available dataset automatic importers

Retrieves a list of available importers to automatically import dataset(s) from an external source. This service does not allow pagination or filters.

path Parameters
tenant
required
string

Customer environment name

header Parameters
Accept-Language
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Registers the execution of a process to import a set of workflows from an external integrated origin

This service allows to start an import process from an integrated external source. This process will automatically create a new dataset and launch the associated asynchronous process for each one of the imported workflows.

path Parameters
importer
required
string

Indicates the external system type to import from

tenant
required
string

Customer environment name

header Parameters
Accept-Language
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "errorMessage": "string",
  • "additionalInfo": [
    ]
}

Retrieves the collection of workflows from an external system

This service retrieves all available workflows to import from an HTTP external source. The importer is specified by path param and must be an existing active importer.

path Parameters
importer
required
string

Indicates the external system type to import from

tenant
required
string

Customer environment name

header Parameters
Accept-Language
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
[
  • {
    }
]

Retrieves the collection of available JDBC drivers

Retrieves a list of all available JDBC drivers to use with an importer.

path Parameters
tenant
required
string

Customer environment name

header Parameters
Accept-Language
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Responses

Response samples

Content type
application/json
[
  • { }
]

Validates the connection parameters

Performs a validation on the input data for a JDBC connection by ensuring all necessary parameters are present and testing the connection with a validation query.

path Parameters
tenant
required
string

Customer environment name

header Parameters
Accept-Language
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Registers the execution of a process to import a set of workflows from an external jdbc origin

This service allows to start an import process from the configured external source. This process will automatically create a new dataset and launch the associated asynchronous process for each one of the imported workflows.

path Parameters
importer
required
string

Indicates the external system type to import from

tenant
required
string

Customer environment name

header Parameters
Accept-Language
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "errorMessage": "string",
  • "additionalInfo": [
    ]
}

Retrieves the collection of workflows from an external system

This service retrieves all available workflows to import from an external source via JDBC driver. The importer is specified by path param and must be an existing active importer. Available JDBC importers can be retrieved by calling /datasets/importers/jdbc

path Parameters
importer
required
string

Indicates the external system type to import from

tenant
required
string

Customer environment name

header Parameters
Accept-Language
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
[
  • {
    }
]

Registers the execution of a process to import a set of workflows from an external integrated origin

This service allows to start an import process from an integrated external source. This process will automatically create a new dataset and launch the associated asynchronous process for each one of the imported workflows.

path Parameters
importer
required
string

Indicates the external system type to import from

tenant
required
string

Customer environment name

header Parameters
Accept-Language
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
required
workflows
required
Array of strings unique
projectUid
required
string

Responses

Request samples

Content type
application/json
{
  • "workflows": [
    ],
  • "projectUid": "string"
}

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "errorMessage": "string",
  • "additionalInfo": [
    ]
}

Retrieves the collection of workflows from an external system

This service retrieves all available workflows to import from an non-configured external source. The importer is specified by path param and must be an existing active importer.

path Parameters
importer
required
string

Indicates the external system type to import from

tenant
required
string

Customer environment name

header Parameters
Accept-Language
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Moves a dataset from one project to another

path Parameters
tenant
required
string

Customer environment name

header Parameters
Accept-Language
required
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
datasetId
required
string

Unique identifier of the dataset

targetProjectId
required
string

Unique identifier of the target project

Responses

Request samples

Content type
application/json
{
  • "datasetId": "string",
  • "targetProjectId": "string"
}

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "errorMessage": "string",
  • "additionalInfo": [
    ]
}

Retrieve a dataset by it's UID

Obtains a specific dataset by its UUID as a path param. The user must have access to the organization in order to retrieve it.

The response class DatasetDTO contains the state of the asynchronous process associated with the dataset, as well as basic information such as name, description and original file name.

path Parameters
datasetUid
required
string

The targeted dataset's UID

tenant
required
string

Customer environment name

header Parameters
Accept-Language
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "data": [
    ]
}

Updates the dataset public information

Allows the update of basic information (name and description) and additional settings of a specific dataset referenced by its UUID as a path param. The associated file can not be changed. Additional settings are definded in DatasetUpdateDTO and include:

  • SLA
  • Case completion conditions
  • Working hours
  • Prediction algorithm

Global SLA can be unassigned by sending a value of -1

path Parameters
datasetUid
required
string

Object containing the new values to update with

tenant
required
string

Customer environment name

header Parameters
Accept-Language
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
required
name
string or null [ 5 .. 100 ] characters
description
string or null [ 0 .. 500 ] characters
updatesEnabled
boolean or null
object

Indicates an update frequency for a dataset

object

Indicates the Service Level Agreement of a process

Array of objects or null (CustomSLADTO)
Array of objects or null (VariantsSLADTO)
object

Indicates the conditions to consider the completion in a process

object

Indicates the Service Level Agreement of a process

Array of objects or null (ActivityCostDTO)
predictionAlgorithm
string or null
object

Indicates the working hours

object

Represents the configuration necessary to simplify the graph activities via zoomer

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "updatesEnabled": true,
  • "frequency": {
    },
  • "sla": {
    },
  • "customSla": [
    ],
  • "variantsSla": [
    ],
  • "caseCompletion": {
    },
  • "cost": {
    },
  • "activityCosts": [
    ],
  • "predictionAlgorithm": "string",
  • "workingHours": {
    },
  • "zoomerConfig": {
    }
}

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "errorMessage": "string",
  • "additionalInfo": [
    ]
}

Generate a new dataset from another filtered dataset

This endpoint creates a new dataset with a given name by applying a set of filters to another dataset. The new dataset will be created under the same project

path Parameters
datasetUid
required
string or null
tenant
required
string or null

Customer environment name

header Parameters
Accept-Language
string or null
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
Array of objects or null (InputFilterDTO)
name
required
string
attributes
Array of strings or null
operator
string or null
filterSets
Array of strings or null

Responses

Request samples

Content type
application/json
{
  • "filters": [
    ],
  • "name": "string",
  • "attributes": [
    ],
  • "operator": "string",
  • "filterSets": [
    ]
}

Response samples

Content type
application/json
{
  • "columns": [
    ]
}

Archive a dataset by it's UID

Allows the soft delete of a dataset. An archived dataset can still be listed calling /datasets with filterArchived=false, but access to additional information such as models will be lost.

path Parameters
datasetUid
required
string
tenant
required
string

Customer environment name

header Parameters
Accept-Language
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Responses

Response samples

Content type
application/json
{
  • "columns": [
    ],
  • "rows": [
    ]
}

Returns the list of activities from a configured dataset

Obtains the set of activities for a specific dataset. This endpoint allows filtering by a set of [InputFilterDTO], and the result will contain only the activities present in the filtered subset of traces.

path Parameters
datasetUid
required
string
tenant
required
string

Customer environment name

query Parameters
alertInfo
number [ 0 .. 10 ]

Display alert info

header Parameters
Accept-Language
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
Array of objects or null

Represents a collections of filters

operator
string or null
Enum: "AND" "OR"

Operator to aggregate filters (optional). Possible values are AND/OR. Default is AND.

filterSets
Array of strings or null

Represents a collections of filtersets

Responses

Request samples

Content type
application/json
{
  • "filters": [
    ],
  • "operator": "AND",
  • "filterSets": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Retrieves a process activity impact

This endpoint retrieves the process activity impact data.

path Parameters
activitySlug
required
string
datasetUid
required
string
tenant
required
string

Customer environment name

header Parameters
Accept-Language
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
Array of objects or null

Represents a collections of filters

operator
string or null
Enum: "AND" "OR"

Operator to aggregate filters (optional). Possible values are AND/OR. Default is AND.

filterSets
Array of strings or null

Represents a collections of filtersets

Responses

Request samples

Content type
application/json
{
  • "filters": [
    ],
  • "operator": "AND",
  • "filterSets": [
    ]
}

Response samples

Content type
application/json
{
  • "total": 0,
  • "data": [
    ]
}

Returns a list of all the alerts for an specific dataset 

                This endpoint returns all previously created alerts for a given dataset.
path Parameters
datasetUid
required
string or null
tenant
required
string or null

Customer environment name

header Parameters
Accept-Language
string or null
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "data": {
    }
}

Creates a new entry in the list of all the alerts for an specific dataset 

                This endpoint a new alert for a given dataset.
path Parameters
datasetUid
required
string or null
tenant
required
string or null

Customer environment name

header Parameters
Accept-Language
string or null
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
required
name
required
string
severity
required
string (SeverityLevels)
Enum: "LOW" "MEDIUM" "HIGH"
required
Array of objects or null (InputFilterDTO)
mailToCreatingUser
boolean or null
mailToNotify
string or null
frequencyNotification
string or null
Enum: "UPDATE" "DAILY" "WEEKLY"
weekDayNotification
string or null
Enum: "MONDAY" "TUESDAY" "WEDNESDAY" "THURSDAY" "FRIDAY" "SATURDAY" "SUNDAY"
timeNotification
object or null

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "severity": "LOW",
  • "filters": [
    ],
  • "mailToCreatingUser": true,
  • "mailToNotify": "string",
  • "frequencyNotification": "UPDATE",
  • "weekDayNotification": "MONDAY",
  • "timeNotification": {
    }
}

Response samples

Content type
application/json
{ }

Obtains evaluations of alerts for a specific dataset 

                This endpoint allows the retrieval and search of evaluations of alerts for a dataset.
                - search: Allows filtering for a specific alert's name
                - start and limit: Pagination parameters
                - dismissed: Filter dismissed evaluations
path Parameters
datasetUid
required
string or null
tenant
required
string or null

Customer environment name

header Parameters
Accept-Language
string or null
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
start
integer or null <int32>
limit
integer or null <int32>
search
string or null
dismissed
boolean or null
alertSeverity
string or null
Enum: "LOW" "MEDIUM" "HIGH"
alertUuid
string or null

Responses

Request samples

Content type
application/json
{
  • "start": 0,
  • "limit": 0,
  • "search": "string",
  • "dismissed": true,
  • "alertSeverity": "LOW",
  • "alertUuid": "string"
}

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "errorMessage": "string",
  • "additionalInfo": [
    ]
}

Obtains evaluation details of alerts for a specific dataset 

                This endpoint allows the retrieval of details of an evaluation of alerts for a dataset.
                - alertUid: AlertUid of the alert
                - alertEvalDate: Evaluation date of the alert
                - start and limit: Pagination parameters
                Both parameters combined distinct an unique alert evaluation.
path Parameters
datasetUid
required
string or null
tenant
required
string or null

Customer environment name

header Parameters
Accept-Language
string or null
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
start
integer or null <int32>
limit
integer or null <int32>
search
string or null
dismissed
boolean or null
alertSeverity
string or null
Enum: "LOW" "MEDIUM" "HIGH"
alertUuid
string or null

Responses

Request samples

Content type
application/json
{
  • "start": 0,
  • "limit": 0,
  • "search": "string",
  • "dismissed": true,
  • "alertSeverity": "LOW",
  • "alertUuid": "string"
}

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "errorMessage": "string",
  • "additionalInfo": [
    ]
}

Marks a specific alert evaluation as dismissed 

                This endpoints set the value "dismissed" to true on a specific alert evaluation. This
                operation can not be undone.
                - alertUid: AlertUid of the alert
                - alertEvalDate: Evaluation date of the alert
                Both parameters combined distinct an unique alert evaluation.
path Parameters
datasetUid
required
string or null
tenant
required
string or null

Customer environment name

header Parameters
Accept-Language
string or null
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
alertUuid
required
string
alertEvalDate
required
string

Responses

Request samples

Content type
application/json
{
  • "alertUuid": "string",
  • "alertEvalDate": "string"
}

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "errorMessage": "string",
  • "additionalInfo": [
    ]
}

Marks a group of alert evaluations that match some conditions as dismissed 

                This endpoints set the value "dismissed" to true on the alert evaluations that
                match some conditions like severity or alertUid. This operation can not be undone.
                - alertSeverity: Severity of the alert
                - alertUid: AlertUid of the alert
path Parameters
datasetUid
required
string or null
tenant
required
string or null

Customer environment name

header Parameters
Accept-Language
string or null
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
alertSeverity
string or null
Enum: "LOW" "MEDIUM" "HIGH"
alertUuid
string or null

Responses

Request samples

Content type
application/json
{
  • "alertSeverity": "LOW",
  • "alertUuid": "string"
}

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "errorMessage": "string",
  • "additionalInfo": [
    ]
}

Returns a specific Alert from the alerts for an specific dataset 

                This endpoint returns a specific created alert for a given dataset.
path Parameters
alertId
required
string
datasetUid
required
string or null
tenant
required
string or null

Customer environment name

header Parameters
Accept-Language
string or null
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "dataset_uuid": "string",
  • "name": "string",
  • "severity": "LOW",
  • "filters": [
    ],
  • "mailToNotify": "string",
  • "mailToCreatingUser": true,
  • "frequencyNotification": "UPDATE",
  • "weekDayNotification": "MONDAY",
  • "timeNotification": {
    },
  • "locale": { }
}

Modifies the E-MAIL or/and Notification options of an alert for an specific dataset 

                Modifies the E-MAIL or/and Notification options of an alert for an specific dataset
path Parameters
alertId
required
string
datasetUid
required
string or null
tenant
required
string or null

Customer environment name

header Parameters
Accept-Language
string or null
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
required
mailToCreatingUser
boolean or null
mailToNotify
string or null
frequencyNotification
string or null
Enum: "UPDATE" "DAILY" "WEEKLY"
weekDayNotification
string or null
Enum: "MONDAY" "TUESDAY" "WEDNESDAY" "THURSDAY" "FRIDAY" "SATURDAY" "SUNDAY"
timeNotification
object or null

Responses

Request samples

Content type
application/json
{
  • "mailToCreatingUser": true,
  • "mailToNotify": "string",
  • "frequencyNotification": "UPDATE",
  • "weekDayNotification": "MONDAY",
  • "timeNotification": {
    }
}

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "errorMessage": "string",
  • "additionalInfo": [
    ]
}

Deletes the list of all the alerts for an specific dataset 

                This endpoint deletes all previously created alerts for a given dataset.
path Parameters
alertId
required
string
datasetUid
required
string or null
tenant
required
string or null

Customer environment name

header Parameters
Accept-Language
string or null
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Responses

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "errorMessage": "string",
  • "additionalInfo": [
    ]
}

Returns the list of arcs from a configured dataset

Obtains the set of arcs for a specific dataset. This endpoint allows filtering by a set of [InputFilterDTO], and the result will contain only the activities present in the filtered subset of traces.

path Parameters
datasetUid
required
string
tenant
required
string

Customer environment name

header Parameters
Accept-Language
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
Array of objects or null

Represents a collections of filters

operator
string or null
Enum: "AND" "OR"

Operator to aggregate filters (optional). Possible values are AND/OR. Default is AND.

filterSets
Array of strings or null

Represents a collections of filtersets

Responses

Request samples

Content type
application/json
{
  • "filters": [
    ],
  • "operator": "AND",
  • "filterSets": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Retrieves a process arc impact

This endpoint retrieves the process arc impact data.

path Parameters
arcSlug
required
string
datasetUid
required
string
tenant
required
string

Customer environment name

header Parameters
Accept-Language
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
Array of objects or null

Represents a collections of filters

operator
string or null
Enum: "AND" "OR"

Operator to aggregate filters (optional). Possible values are AND/OR. Default is AND.

filterSets
Array of strings or null

Represents a collections of filtersets

Responses

Request samples

Content type
application/json
{
  • "filters": [
    ],
  • "operator": "AND",
  • "filterSets": [
    ]
}

Response samples

Content type
application/json
{
  • "total": 0,
  • "data": [
    ]
}

/v0/{tenant}/datasets/{datasetUid}/assistant/history

path Parameters
datasetUid
required
string or null
tenant
required
string or null

Customer environment name

header Parameters
Accept-Language
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Responses

/v0/{tenant}/datasets/{datasetUid}/assistant/initthread

path Parameters
datasetUid
required
string or null
tenant
required
string or null

Customer environment name

header Parameters
Accept-Language
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Responses

/v0/{tenant}/datasets/{datasetUid}/assistant/restartThread

path Parameters
datasetUid
required
string or null
tenant
required
string or null

Customer environment name

header Parameters
Accept-Language
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Responses

/v0/{tenant}/datasets/{datasetUid}/assistant/sendMessage/{text}

path Parameters
datasetUid
required
string or null
tenant
required
string or null

Customer environment name

text
required
string
header Parameters
Accept-Language
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Responses

/v0/{tenant}/datasets/{datasetUid}/assistant/substituteFile

path Parameters
datasetUid
required
string or null
tenant
required
string or null

Customer environment name

header Parameters
Accept-Language
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Responses

/v0/{tenant}/datasets/{datasetUid}/assistant/uploadFileAndInitThread

path Parameters
datasetUid
required
string or null
tenant
required
string or null

Customer environment name

header Parameters
Accept-Language
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Responses

/v0/{tenant}/datasets/{datasetUid}/assistant/uploadfile

path Parameters
datasetUid
required
string or null
tenant
required
string or null

Customer environment name

header Parameters
Accept-Language
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Responses

Get categorical attributes

Obtains a list of string-type attributes with all possible values

path Parameters
tenant
required
string or null

Customer environment name

datasetUid
required
string
header Parameters
Accept-Language
string or null
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
Array of objects or null

Represents a collections of filters

operator
string or null
Enum: "AND" "OR"

Operator to aggregate filters (optional). Possible values are AND/OR. Default is AND.

filterSets
Array of strings or null

Represents a collections of filtersets

Responses

Request samples

Content type
application/json
{
  • "filters": [
    ],
  • "operator": "AND",
  • "filterSets": [
    ]
}

Response samples

Content type
application/json
{
  • "columns": [
    ]
}

Returns a list with each comparison and its parameters 

                This endpoint provides the means to obtain the list of available comparisons and its parameters
path Parameters
datasetUid
required
string or null
tenant
required
string or null

Customer environment name

header Parameters
Accept-Language
string or null
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "attribute": "string",
  • "attributeType": "string",
  • "filtersEnabled": true,
  • "sortBy": "string",
  • "viewMode": "string",
  • "activityBreakdown": true,
  • "activities": [
    ],
  • "startValue": 0.1,
  • "endValue": 0.1
}

Register a list of comparisons 

                This endpoint provides means to save a list of comparisons.
path Parameters
datasetUid
required
string or null
tenant
required
string or null

Customer environment name

header Parameters
Accept-Language
string or null
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
required
Array of objects or null (DatasetComparisonDTO)

Responses

Request samples

Content type
application/json
{
  • "comparisons": [
    ]
}

Response samples

Content type
application/json
{ }

Returns the list of available configurations for an specific dataset

This endpoint provides the means to obtain the list of available configuration for an specific dataset.

A dataset must have none or one configuration.

path Parameters
datasetUid
required
string
tenant
required
string

Customer environment name

header Parameters
Accept-Language
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "data": [
    ]
}

Registers the specific schema and key field configuration for a dataset

This endpoint provides the means required to setup the schema of a dataset and the configuration of the key fields required in order to be able to perform process mining analysis over the data set and explore the data.

Each dataset can only contains one configuration and it is not possible to change it, by registering this configuration the dataset is ready to be processed and begin to work with it.

The fields names required as input for the columns can be obtained by invoking the operation DatasetInferSchema they are the same as the csv file in camel case in case that the dataset was generated by uploading a csv file.

path Parameters
datasetUid
required
string
tenant
required
string

Customer environment name

header Parameters
Accept-Language
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
name
string or null [ 1 .. 100 ] characters

Name of the configuration

traceColumn
required
string
activityColumn
required
string
startTimeColumn
required
string
endTimeColumn
string or null
required
Array of objects (ConfigurationDateFieldDTO) [ 3 .. 100 ] items
homogenizeAttr
boolean or null

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "traceColumn": "string",
  • "activityColumn": "string",
  • "startTimeColumn": "string",
  • "endTimeColumn": "string",
  • "columns": [
    ],
  • "homogenizeAttr": true
}

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "errorMessage": "string",
  • "additionalInfo": [
    ]
}

Updates relevant field configuration for a dataset

Allows the update of column information (relevant) of a specific configuration for a dataset referenced by its UUID as a path param and giving context of the update which can be 'SETTINGS' or 'BOOSTER' allowing empty array in the first case and enforcing at least one in the second case.

path Parameters
context
required
string
datasetUid
required
string
tenant
required
string

Customer environment name

header Parameters
Accept-Language
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
columnNames
required
Array of strings or null <= 100 characters <= 3 items

Name of the column

Responses

Request samples

Content type
application/json
{
  • "columnNames": [
    ]
}

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "errorMessage": "string",
  • "additionalInfo": [
    ]
}

Returns a specific configuration from a dataset

This endpoint provides the means to obtain a specific configuration from a dataset.

A dataset must have none or one configuration.

path Parameters
configurationUid
required
string
datasetUid
required
string
tenant
required
string

Customer environment name

header Parameters
Accept-Language
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "data": [
    ]
}

Generate a new dataset from dataset with zoomer configuration

This endpoint creates a new dataset with a given name by applying a set of zoomer configurations to another dataset. The new dataset will be created under the same project

path Parameters
datasetUid
required
string or null
tenant
required
string or null

Customer environment name

header Parameters
Accept-Language
string or null
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
required
object (ZoomerConfigDTO)

Represents the configuration necessary to simplify the graph activities via zoomer

name
required
string

Responses

Request samples

Content type
application/json
{
  • "zoomerConfig": {
    },
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "columns": [
    ]
}

Returns information about SLA compliance

path Parameters
datasetUid
required
string or null
tenant
required
string or null

Customer environment name

header Parameters
Accept-Language
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
Array of objects or null

Represents a collections of filters

variantUid
Array of strings or null <uuid> [ items <uuid >[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-... ]

Represents the UUIDs of variants

loopUid
number or null

Represents the id of a loop

variantCount
number or null <int32> >= 1

Represents a number of variants to aggregate

operator
string or null
Enum: "AND" "OR"

Operator to aggregate filters (optional). Possible values are AND/OR. Default is AND.

filterSets
Array of strings or null

Represents a collections of filtersets

Responses

Request samples

Content type
application/json
{
  • "filters": [
    ],
  • "variantUid": [
    ],
  • "loopUid": 0,
  • "variantCount": 1,
  • "operator": "AND",
  • "filterSets": [
    ]
}

Response samples

Content type
application/json
{
  • "type": "string",
  • "elements": [
    ],
  • "unit": "string",
  • "value": 0,
  • "loopMode": "string",
  • "sourceOccurrence": "string",
  • "targetOccurrence": "string"
}

Add a new dashboard to a dataset

path Parameters
datasetUid
required
string or null
tenant
required
string or null

Customer environment name

header Parameters
Accept-Language
string or null
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
required
identifier
string or null
name
required
string
size
required
Array of integers <int32> [ items <int32 > ]
dashboardFilters
required
string
required
Array of objects (DashboardElementDAO)

Responses

Request samples

Content type
application/json
{
  • "identifier": "string",
  • "name": "string",
  • "size": [
    ],
  • "dashboardFilters": "string",
  • "content": [
    ]
}

Response samples

Content type
application/json
{ }

Get a dashboard of a dataset

path Parameters
datasetUid
required
string or null
tenant
required
string or null

Customer environment name

header Parameters
Accept-Language
string or null
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Responses

Response samples

Content type
application/json
{ }

Get a dashboard of a dataset

path Parameters
dashboardId
required
string
datasetUid
required
string or null
tenant
required
string or null

Customer environment name

header Parameters
Accept-Language
string or null
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Responses

Response samples

Content type
application/json
{ }

Edits a dashboard of a dataset

path Parameters
dashboardId
required
string
datasetUid
required
string or null
tenant
required
string or null

Customer environment name

header Parameters
Accept-Language
string or null
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
required
identifier
string or null
name
required
string
size
required
Array of integers <int32> [ items <int32 > ]
dashboardFilters
required
string
required
Array of objects (DashboardElementDAO)

Responses

Request samples

Content type
application/json
{
  • "identifier": "string",
  • "name": "string",
  • "size": [
    ],
  • "dashboardFilters": "string",
  • "content": [
    ]
}

Response samples

Content type
application/json
{ }

Add a new dashboard to a dataset

path Parameters
dashboardId
required
string
datasetUid
required
string or null
tenant
required
string or null

Customer environment name

header Parameters
Accept-Language
string or null
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Responses

Response samples

Content type
application/json
{ }

Get a dashboard of a dataset

path Parameters
dashboardId
required
string
datasetUid
required
string or null
tenant
required
string or null

Customer environment name

header Parameters
Accept-Language
string or null
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
required
name
string or null [ 1 .. 100 ] characters

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{ }

Deletes the general SLA from the dataset

Allows the deletion of the general SLA of a specific dataset referenced by its UUID as a path param. The associated file can not be changed.

path Parameters
datasetUid
required
string
tenant
required
string

Customer environment name

header Parameters
Accept-Language
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Responses

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "errorMessage": "string",
  • "additionalInfo": [
    ]
}

Returns metrics for each activity 

    This service exports the activities on a dataset and metrics.

    This service supports filtering via a collection of [InputFilterDTO]. In addition, you can specify an operator to combine the filters.
path Parameters
datasetUid
required
string
tenant
required
string or null

Customer environment name

header Parameters
Accept-Language
string or null
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
required
Array of objects or null (InputFilterDTO)

Filters to apply

operator
required
string or null

Logical operator to combine filters

Responses

Request samples

Content type
application/json
{
  • "filters": [
    ],
  • "operator": "string"
}

Response samples

Content type
application/json
{
  • "traceId": "string",
  • "index": 0,
  • "activity": "string",
  • "start": "string",
  • "end": "string",
  • "duration": 0.1,
  • "cw_normalized": 0.1,
  • "attributes": {
    }
}

Returns metrics for each arc 

    This service exports the arcs on a dataset and metrics.

    This service supports filtering via a collection of [InputFilterDTO]. In addition, you can specify an operator to combine the filters.
path Parameters
datasetUid
required
string
tenant
required
string or null

Customer environment name

header Parameters
Accept-Language
string or null
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
required
Array of objects or null (InputFilterDTO)

Filters to apply

operator
required
string or null

Logical operator to combine filters

Responses

Request samples

Content type
application/json
{
  • "filters": [
    ],
  • "operator": "string"
}

Response samples

Content type
application/json
{
  • "traceId": "string",
  • "index": 0,
  • "name": "string",
  • "source": "string",
  • "target": "string",
  • "start": "string",
  • "end": "string",
  • "duration": 0.1,
  • "cw_normalized": 0.1
}

Returns aggregated information about a dataset 

    This service retrieves aggregated information about a dataset. It informs about the number
    of traces, variants, activities and arcs present in the dataset, as well as aggregated information about durations.
    
    This service supports filtering via a collection of [InputFilterDTO]. In addition, you can specify an operator to combine the filters.
path Parameters
datasetUid
required
string
tenant
required
string or null

Customer environment name

header Parameters
Accept-Language
string or null
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
required
Array of objects or null (InputFilterDTO)

Filters to apply

operator
required
string or null

Logical operator to combine filters

Responses

Request samples

Content type
application/json
{
  • "filters": [
    ],
  • "operator": "string"
}

Response samples

Content type
application/json
{
  • "traces": {
    },
  • "traceArcs": {
    },
  • "traceActivities": {
    },
  • "loops": {
    }
}

Exports traces from a dataset to PowerBI table showing right

path Parameters
datasetUid
required
string
tenant
required
string or null

Customer environment name

header Parameters
Accept-Language
string or null
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
required
Array of objects or null

Represents a collection of filters

operator
required
string or null
Enum: "AND" "OR"

Operator to aggregate filters (optional). Possible values are AND/OR. Default is AND.

Responses

Request samples

Content type
application/json
{
  • "filters": [
    ],
  • "operator": "AND"
}

Response samples

Content type
application/json
"{\n \"traceId\": \"137a3571-a40b-41cf-b7c4-70db5b8029d5\",\n \"start\": \"2021-04-15T10:20:39Z\",\n \"end\": \"2021-04-15T10:20:39Z\",\n \"duration\": 290312,\n \"eventCount\": 13,\n \"variantHashID\": \"ee5bcb71-c6ba-42a5-b221-d46f85375979\",\n \"variantName\": \"#1\",\n \"activitySequence\": \"Activity1->Activity2->Activity3>Activity4\",\n }"

Exports all trace events from a dataset in CSV format

path Parameters
datasetUid
required
string or null
tenant
required
string or null

Customer environment name

header Parameters
Accept-Language
string or null
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Responses

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "errorMessage": "string",
  • "additionalInfo": [
    ]
}

Exports all trace events from a dataset in CSV format

path Parameters
datasetUid
required
string or null
tenant
required
string or null

Customer environment name

header Parameters
Accept-Language
string or null
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Responses

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "errorMessage": "string",
  • "additionalInfo": [
    ]
}

Exports all trace arcs from a dataset in CSV format

path Parameters
datasetUid
required
string or null
tenant
required
string or null

Customer environment name

header Parameters
Accept-Language
string or null
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Responses

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "errorMessage": "string",
  • "additionalInfo": [
    ]
}

Exports all traces from a dataset in CSV format

path Parameters
datasetUid
required
string or null
tenant
required
string or null

Customer environment name

header Parameters
Accept-Language
string or null
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Responses

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "errorMessage": "string",
  • "additionalInfo": [
    ]
}

Returns a list of available filter sets for a specific dataset

This endpoint returns all previously created filter sets for a given dataset. New filter sets can be defined making a POST request to /datasets/{datasetUid}/filters

path Parameters
datasetUid
required
string
tenant
required
string

Customer environment name

header Parameters
Accept-Language
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "data": [
    ]
}

Register a new filter set for a dataset

This endpoint provides means to create a new filter set. Filters sets consist of a name and at least one filter.

path Parameters
datasetUid
required
string
tenant
required
string

Customer environment name

header Parameters
Accept-Language
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
required
name
required
string [ 1 .. 50 ] characters

Name of the saved filter

Array of objects (InputFilterDTO) [ 1 .. 100 ] items

Collection of filters

operator
string or null
Enum: "AND" "OR"

Operator to aggregate filters (optional). Possible values are AND/OR. Default is AND.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "filters": [
    ],
  • "operator": "AND"
}

Response samples

Content type
application/json
{ }

Deletes the list of all the selected filtersets for an specific dataset 

                This endpoint deletes all selected filtersets for a given dataset.
path Parameters
datasetUid
required
string or null
tenant
required
string or null

Customer environment name

header Parameters
Accept-Language
string or null
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
required
filters
required
Array of strings

Represents a collections of filtersets

Responses

Request samples

Content type
application/json
{
  • "filters": [
    ]
}

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "errorMessage": "string",
  • "additionalInfo": [
    ]
}

Updates a filter set

This endpoint updates a filter set from a dataset, specified by the dataset and the filter set UUIDs.

path Parameters
datasetUid
required
string or null
filterUid
required
string or null
tenant
required
string or null

Customer environment name

header Parameters
Accept-Language
string or null
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
required
operator
required
string

Represents an update for an existing filterset

Responses

Request samples

Content type
application/json
{
  • "operator": "string"
}

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "errorMessage": "string",
  • "additionalInfo": [
    ]
}

Deletes a filter set

This endpoint deletes a filter set from a dataset, specified by the dataset and the filter set UUIDs.

path Parameters
datasetUid
required
string
filterUid
required
string
tenant
required
string

Customer environment name

header Parameters
Accept-Language
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Responses

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "errorMessage": "string",
  • "additionalInfo": [
    ]
}

Retrieve a dataset by it's UID

Obtains additional information about a specific dataset by its UUID as a path param. The user must have access to the organization in order to retrieve it. Provides information such as:

  • Number of events
  • Number of traces
  • Number of variants
  • Number of activities
  • Number of arcs
path Parameters
datasetUid
required
string

The targeted dataset's UID

tenant
required
string

Customer environment name

header Parameters
Accept-Language
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Responses

Response samples

Content type
application/json
{
  • "events": 0,
  • "traces": 0,
  • "variants": 0,
  • "activities": 0,
  • "arcs": 0
}

Returns a list with each attribute plot and its parameters for the dataset 

                This endpoint provides the means to obtain the list of available attribute plots and its parameters
                for an specific dataset.
path Parameters
datasetUid
required
string or null
tenant
required
string or null

Customer environment name

header Parameters
Accept-Language
string or null
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "attribute": "string",
  • "attributeType": "string",
  • "filtersEnabled": true,
  • "sortBy": "string",
  • "viewMode": "string",
  • "activityBreakdown": true,
  • "activities": [
    ],
  • "startValue": 0.1,
  • "endValue": 0.1
}

Register a list of plots for a dataset 

                This endpoint provides means to save a list of plots for a dataset.
path Parameters
datasetUid
required
string or null
tenant
required
string or null

Customer environment name

header Parameters
Accept-Language
string or null
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
required
Array of objects or null (DatasetPlotDTO)

Responses

Request samples

Content type
application/json
{
  • "plots": [
    ]
}

Response samples

Content type
application/json
{ }

Returns a list of values of freq/dur for the selected categorical attribute 

                Returns a list of values of freq/dur for values of the selected categorical attribute
path Parameters
datasetUid
required
string or null
tenant
required
string or null

Customer environment name

header Parameters
Accept-Language
string or null
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
start
integer or null <int32>
limit
integer or null <int32>
attribute
string or null
sortBy
string or null
eventAttribute
boolean or null
variantUid
Array of strings or null
loopUid
string or null
variantCount
integer or null <int32>
Array of objects or null (InputFilterDTO)
activities
Array of strings or null
operator
string or null
timeUnit
string or null
filterSets
Array of strings or null
startValue
number or null <double>
endValue
number or null <double>
timeGroups
integer or null <int32>

Responses

Request samples

Content type
application/json
{
  • "start": 0,
  • "limit": 0,
  • "attribute": "string",
  • "sortBy": "string",
  • "eventAttribute": true,
  • "variantUid": [
    ],
  • "loopUid": "string",
  • "variantCount": 0,
  • "filters": [
    ],
  • "activities": [
    ],
  • "operator": "string",
  • "timeUnit": "string",
  • "filterSets": [
    ],
  • "startValue": 0.1,
  • "endValue": 0.1,
  • "timeGroups": 0
}

Response samples

Content type
application/json
{
  • "categoricalRows": [
    ],
  • "numericalRows": [
    ],
  • "data": {
    }
}

Returns a list of values of freq/dur for aggregated units of time 

                Returns a list of values of freq/dur for aggregated units of time
path Parameters
datasetUid
required
string or null
tenant
required
string or null

Customer environment name

header Parameters
Accept-Language
string or null
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
start
integer or null <int32>
limit
integer or null <int32>
duration
string or null
caseType
string or null
variantUid
Array of strings or null
loopUid
string or null
variantCount
integer or null <int32>
Array of objects or null (InputFilterDTO)
operator
string or null
filterSets
Array of strings or null

Responses

Request samples

Content type
application/json
{
  • "start": 0,
  • "limit": 0,
  • "duration": "string",
  • "caseType": "string",
  • "variantUid": [
    ],
  • "loopUid": "string",
  • "variantCount": 0,
  • "filters": [
    ],
  • "operator": "string",
  • "filterSets": [
    ]
}

Response samples

Content type
application/json
{
  • "rows": [
    ]
}

Returns the model discovered from the traces present in the dataset

This services allows to obtain a model for specific dataset that aggregated a number of different model variants. The variants are aggregated by adding all different activities and arcs present, and recalculating frequencies and durations. The "variants" parameter indicates how many different variants are to be aggregated in the result. The variants are always sorted by frequency, and this can not be changed. This endpoint also allows filtering by a set of [InputFilterDTO].

path Parameters
datasetUid
required
string
tenant
required
string

Customer environment name

header Parameters
Accept-Language
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
required
Array of objects or null

Represents a collections of filters

variants
integer or null <int32> [ 0 .. 2147483647 ]

Number of aggregated variants to display

operator
string or null
Enum: "AND" "OR"

Operator to aggregate filters (optional). Possible values are AND/OR. Default is AND.

groupedActivities
string or null
Enum: "AND" "OR"

Represent collections of grouped activities

excludedActivities
string or null
Enum: "AND" "OR"

Operator to aggregate filters (optional). Possible values are AND/OR. Default is AND.

filterSets
Array of strings or null

Represents a collections of filtersets

Responses

Request samples

Content type
application/json
{
  • "filters": [
    ],
  • "variants": 2147483647,
  • "operator": "AND",
  • "groupedActivities": "AND",
  • "excludedActivities": "AND",
  • "filterSets": [
    ]
}

Response samples

Content type
application/json
{
  • "total": 0,
  • "data": [
    ]
}

Downloads a zip with a summary of the models discovered and traces analyzed

When a dataset is processed, besides the models, loops and dashboards, a ZIP file is generated containing a summary of all information generated in the process. This endpoint allows the download of said file in order to export the data. The ZIP file contains four CSV files:

  • variants.csv
  • traces.csv
  • loops.csv
  • activities.csv
  • arcs.csv
path Parameters
datasetUid
required
string
tenant
required
string

Customer environment name

header Parameters
Accept-Language
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Responses

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "errorMessage": "string",
  • "additionalInfo": [
    ]
}

Returns basic information about dataset process models

This service retrieves contextual information about a dataset. In particular, it informs about the number of traces, variants, activities and arcs present in the dataset, as well as aggregated information about durations.

This service supports filtering via a collection of [InputFilterDTO]. In addition to this filtering, a single model can be selected including only one of the following parameters:

  • variantUid: Select a specific variant
  • loopUid: Select a specific loop
  • variantCount: Select the aggregated model of the N most frequent variants

By including one of these three parameters, this service returns the contextual information for that specific model, taking into account the other selected filters.

path Parameters
datasetUid
required
string
tenant
required
string

Customer environment name

header Parameters
Accept-Language
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
Array of objects or null

Represents a collections of filters

variantUid
Array of strings or null <uuid> [ items <uuid >[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-... ]

Represents the UUIDs of variants

loopUid
number or null

Represents the id of a loop

variantCount
number or null <int32> >= 1

Represents a number of variants to aggregate

operator
string or null
Enum: "AND" "OR"

Operator to aggregate filters (optional). Possible values are AND/OR. Default is AND.

filterSets
Array of strings or null

Represents a collections of filtersets

Responses

Request samples

Content type
application/json
{
  • "filters": [
    ],
  • "variantUid": [
    ],
  • "loopUid": 0,
  • "variantCount": 1,
  • "operator": "AND",
  • "filterSets": [
    ]
}

Response samples

Content type
application/json
{
  • "variants": 0,
  • "cases": 0,
  • "activities": 0,
  • "transitions": 0,
  • "duration": {
    },
  • "minStartDateTime": {
    },
  • "maxEndDateTime": {
    },
  • "customSLA": { }
}

Retrieves list of loops found for the process including self loops

Returns a list of loop structures present in the specified dataset sorted by frequency. This endpoint provides only the sorted list with loop's names and frequencies. In order to obtain the full loop structure, /{datasetUid}/models/loops/{loopId} must be called. This service allows filtering by [InputFilterDTO], as well as pagination, text search by loop name, and searching only self-loops (loops with only one activity with an arc to itself).

path Parameters
datasetUid
required
string
tenant
required
string

Customer environment name

header Parameters
Accept-Language
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
Array of objects or null

Represents a collections of filters

self
boolean or null

Search by name

search
string or null

Text search by name or id

start
integer or null <int32>

Page index for pagination

limit
integer or null <int32>

Page size for pagination

variants
integer or null <int32>

Number of variants to show

variantsId
Array of strings or null

Id of the variants containing the loops

operator
string or null
Enum: "AND" "OR"

Operator to aggregate filters (optional). Possible values are AND/OR. Default is AND.

filterSets
Array of strings or null

Represents a collections of filtersets

Responses

Request samples

Content type
application/json
{
  • "filters": [
    ],
  • "self": true,
  • "search": "string",
  • "start": 0,
  • "limit": 0,
  • "variants": 0,
  • "variantsId": [
    ],
  • "operator": "AND",
  • "filterSets": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Rename one specific loop

Rename a specific model loop from a dataset by specifying both UUIDs as path params, and the new name as body.

path Parameters
datasetUid
required
string or null
loopUid
required
string or null
tenant
required
string or null

Customer environment name

header Parameters
Accept-Language
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
required
name
required
string or null [ 1 .. 100 ] characters

Name of the loop

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "errorMessage": "string",
  • "additionalInfo": [
    ]
}

Retrieves a process loops

path Parameters
datasetUid
required
string
loopUid
required
string
tenant
required
string

Customer environment name

header Parameters
Accept-Language
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
Array of objects or null

Represents a collections of filters

operator
string or null
Enum: "AND" "OR"

Operator to aggregate filters (optional). Possible values are AND/OR. Default is AND.

filterSets
Array of strings or null

Represents a collections of filtersets

Responses

Request samples

Content type
application/json
{
  • "filters": [
    ],
  • "operator": "AND",
  • "filterSets": [
    ]
}

Response samples

Content type
application/json
{
  • "total": 0,
  • "data": [
    ]
}

Retrieves an aggregate of multiple variants

Retrieves a model of aggregated multiple variants from a dataset by specifying variant UUIDs in the body of the request alongside optional filters. If found, the response contains the structure of the variant as a set of activities and arcs, as well as their frequencies and aggregated duration information.

path Parameters
datasetUid
required
string
tenant
required
string

Customer environment name

header Parameters
Accept-Language
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
variantsUids
required
Array of strings
required
Array of objects or null (InputFilterDTO)
operator
required
string or null
required
Array of objects or null (GroupedActivitiesDTO)
excludedActivities
required
Array of strings or null
filterSets
required
Array of strings or null

Responses

Request samples

Content type
application/json
{
  • "variantsUids": [
    ],
  • "filters": [
    ],
  • "operator": "string",
  • "groupedActivities": [
    ],
  • "excludedActivities": [
    ],
  • "filterSets": [
    ]
}

Response samples

Content type
application/json
{
  • "total": 0,
  • "data": [
    ]
}

Retrieves the list of process variants for an specific dataset

This endpoint retrieves a subset of model variants for a specific dataset, sorted by frequency. It allows pagination, text search by variant name and filtering by a collection [InputFilterDTO].

This service provides only basic information about the variants: name, frequency and UUID. In order to obtain the structure of the variant and all related information, /{datasetUid}/models/variants/{variantUid} must be called.

path Parameters
datasetUid
required
string
tenant
required
string

Customer environment name

header Parameters
Accept-Language
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
Array of objects or null

Represents a collections of filters

search
string or null

Text search by name or id

start
integer or null <int32>

Page index for pagination

limit
integer or null <int32>

Page size for pagination

sortBy
object or null
Enum: "TRACE_ID" "START_TIME" "END_TIME" "DURATION" "TRACE_LENGTH" "VARIANT_ID"

Sort criteria

sortDirection
object or null
Enum: "ASCENDING" "DESCENDING"

Sort direction

attributes
Array of strings or null

Represents a list of attributes to be filtered

orderDurationBy
object or null
Enum: "FREQUENCY" "AVERAGE" "MEDIAN" "SD"

Ordering duration criteria

operator
string or null
Enum: "AND" "OR"

Operator to aggregate filters (optional). Possible values are AND/OR. Default is AND.

filterSets
Array of strings or null

Represents a collections of filtersets

Responses

Request samples

Content type
application/json
{
  • "filters": [
    ],
  • "search": "string",
  • "start": 0,
  • "limit": 0,
  • "sortBy": "TRACE_ID",
  • "sortDirection": "ASCENDING",
  • "attributes": [
    ],
  • "orderDurationBy": "FREQUENCY",
  • "operator": "AND",
  • "filterSets": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Rename one specific variant

Rename a specific model variant from a dataset by specifying both UUIDs as path params, and the new name as body.

path Parameters
datasetUid
required
string or null
tenant
required
string or null

Customer environment name

variantUid
required
string or null
header Parameters
Accept-Language
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
required
name
required
string or null [ 1 .. 100 ] characters

Name of the variant

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "errorMessage": "string",
  • "additionalInfo": [
    ]
}

Retrieves one specific variant

Retrieves a specific model variant from a dataset by specifying both UUIDs as path params. If found, the response contains the structure of the variant as a set of activities and arcs, as well as their frequencies and aggregated duration information.

path Parameters
datasetUid
required
string
tenant
required
string

Customer environment name

variantUid
required
string
header Parameters
Accept-Language
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
Array of objects or null

Represents a collections of filters

operator
string or null
Enum: "AND" "OR"

Operator to aggregate filters (optional). Possible values are AND/OR. Default is AND.

filterSets
Array of strings or null

Represents a collections of filtersets

Responses

Request samples

Content type
application/json
{
  • "filters": [
    ],
  • "operator": "AND",
  • "filterSets": [
    ]
}

Response samples

Content type
application/json
{
  • "total": 0,
  • "data": [
    ]
}

Get numerical attributes

Obtains a list of min and max values for numerical attributes

path Parameters
tenant
required
string or null

Customer environment name

datasetUid
required
string
header Parameters
Accept-Language
string or null
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
Array of objects or null

Represents a collections of filters

operator
string or null
Enum: "AND" "OR"

Operator to aggregate filters (optional). Possible values are AND/OR. Default is AND.

filterSets
Array of strings or null

Represents a collections of filtersets

Responses

Request samples

Content type
application/json
{
  • "filters": [
    ],
  • "operator": "AND",
  • "filterSets": [
    ]
}

Response samples

Content type
application/json
{
  • "columns": [
    ]
}

Change dataset´s open flag

This service change the dataset's open flag.

path Parameters
datasetUid
required
string
tenant
required
string

Customer environment name

header Parameters
Accept-Language
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "data": [
    ]
}

Guess the schema of a dataset based on the actual content

This endpoint provide means to guess the schema of a dataset provided by a csv file to Inverbis, in order to do that the service collects a sample of the first one hundred lines of the csv file and searches for the most specific type for each column within the following:

  • TIMESTAMP: Any kind of date or date and time, the format will be guessed using a best effort algorithm.
  • DECIMAL: Any number with a decimal point value.
  • LONG: Any positive or negative number in the range Integer.MAX_VALUE to Long.MAX_VALUE
  • INTEGER: Any positive or negative number in the absolute range of Short.MAX_VALUE and Integer.MAX_VALUE
  • SHORT: Any number between Short.MIN_VALUE and Short.MAX_VALUE
  • BOOLEAN: The strings "true" or "false".
  • STRING: Any value.
  • NULL: Any empty value.

If a column contains values belonging to different data types or if its not possible to determine the specific datatype, it will be recognized as a STRING column. While guessing TIMESTAMP columns, the date time format will also be guessed and returned. For DECIMAL columns, the service will try to parse the column value using the default symbol configuration for the Locale US, but if the symbols are provided in the invocation, those will be used instead.

path Parameters
datasetUid
required
string
tenant
required
string

Customer environment name

header Parameters
Accept-Language
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
decimalSeparator
string or null <= 1 characters

Character use to separate decimal part in the dataset

groupingSeparator
string or null <= 1 characters

Character use to group thousands in numbers within the dataset

Responses

Request samples

Content type
application/json
{
  • "decimalSeparator": "s",
  • "groupingSeparator": "s"
}

Response samples

Content type
application/json
{
  • "columns": [
    ]
}

Retrieve the info about the SLA compliance in a Dataset. 

                Returns the number of cases in the data set that meet and do not meet the SLA, 
                as well as the percentage that each group represents of the total cases.
path Parameters
datasetUid
required
string or null
tenant
required
string or null

Customer environment name

header Parameters
Accept-Language
string or null
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
unit
required
string

Time unit. One of [seconds, minutes, hours, days, weeks, months]

value
number

Time quantity

Responses

Request samples

Content type
application/json
{
  • "unit": "string",
  • "value": 0
}

Response samples

Content type
application/json
{
  • "meetSlaAbsolute": 0,
  • "meetSlaPercentage": 0.1,
  • "exceedSlaAbsolute": 0,
  • "exceedSlaPercentage": 0.1
}

Returns the activities from the traces present in the dataset 

    This services allows to obtain the activities for specific dataset that aggregated a number of different model variants.
    The activities are returned in 3 sets, the initial activities, the final activities and all the activities.
    This endpoint also allows filtering by a set of [InputFilterDTO].
path Parameters
datasetUid
required
string or null
tenant
required
string or null

Customer environment name

header Parameters
Accept-Language
string or null
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
required
required
Array of objects or null (InputFilterDTO)
operator
required
string or null
filterSets
required
Array of strings or null
arcs
boolean or null

Responses

Request samples

Content type
application/json
{
  • "filters": [
    ],
  • "operator": "string",
  • "filterSets": [
    ],
  • "arcs": true
}

Response samples

Content type
application/json
{
  • "meetSlaAbsolute": 0,
  • "meetSlaPercentage": 0.1,
  • "exceedSlaAbsolute": 0,
  • "exceedSlaPercentage": 0.1
}

Retrieves events from a dataset.

This endpoint provides means to obtain traces from a dataset. As traces are conformed by an uncertain amount of events, the service returns individual events sorted by trace ID, and by start time within each trace. This implies that one request to this endpoint can return incomplete traces due to pagination.

The service allows pagination and text search by trace ID, as well as filtering using a collection of [InputFilterDTO].

Events contain its trace ID, activity name, start date and, optionally, end date. Additionally, events contain a map with all non-key attributes indexed by a normalized name

path Parameters
datasetUid
required
string
tenant
required
string

Customer environment name

header Parameters
Accept-Language
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
Array of objects or null

Represents a collections of filters

search
string or null

Text search by name or id

start
integer or null <int32>

Page index for pagination

limit
integer or null <int32>

Page size for pagination

sortBy
object or null
Enum: "TRACE_ID" "START_TIME" "END_TIME" "DURATION" "TRACE_LENGTH" "VARIANT_ID"

Sort criteria

sortDirection
object or null
Enum: "ASCENDING" "DESCENDING"

Sort direction

attributes
Array of strings or null

Represents a list of attributes to be filtered

orderDurationBy
object or null
Enum: "FREQUENCY" "AVERAGE" "MEDIAN" "SD"

Ordering duration criteria

operator
string or null
Enum: "AND" "OR"

Operator to aggregate filters (optional). Possible values are AND/OR. Default is AND.

filterSets
Array of strings or null

Represents a collections of filtersets

Responses

Request samples

Content type
application/json
{
  • "filters": [
    ],
  • "search": "string",
  • "start": 0,
  • "limit": 0,
  • "sortBy": "TRACE_ID",
  • "sortDirection": "ASCENDING",
  • "attributes": [
    ],
  • "orderDurationBy": "FREQUENCY",
  • "operator": "AND",
  • "filterSets": [
    ]
}

Response samples

Content type
application/json
{
  • "columns": [
    ]
}

Download events with more information from a dataset.

Generates a CSV file with filtered traces

path Parameters
datasetUid
required
string or null
tenant
required
string or null

Customer environment name

header Parameters
Accept-Language
string or null
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
attributes
Array of strings or null

Represents a list of attributes to be filtered

Array of objects or null

Represents a collections of filters

operator
string or null
Enum: "AND" "OR"

Operator to aggregate filters (optional). Possible values are AND/OR. Default is AND.

filterSets
Array of strings or null

Represents a collections of filtersets

Responses

Request samples

Content type
application/json
{
  • "attributes": [
    ],
  • "filters": [
    ],
  • "operator": "AND",
  • "filterSets": [
    ]
}

Response samples

Content type
application/json
{
  • "columns": [
    ]
}

Download events from a dataset.

Generates a CSV file with filtered traces

path Parameters
datasetUid
required
string or null
tenant
required
string or null

Customer environment name

header Parameters
Accept-Language
string or null
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
attributes
Array of strings or null

Represents a list of attributes to be filtered

Array of objects or null

Represents a collections of filters

operator
string or null
Enum: "AND" "OR"

Operator to aggregate filters (optional). Possible values are AND/OR. Default is AND.

filterSets
Array of strings or null

Represents a collections of filtersets

Responses

Request samples

Content type
application/json
{
  • "attributes": [
    ],
  • "filters": [
    ],
  • "operator": "AND",
  • "filterSets": [
    ]
}

Response samples

Content type
application/json
{
  • "columns": [
    ]
}

Allows pushing new traces to a dataset

path Parameters
datasetUid
required
string

Dataset UUID

tenant
required
string or null

Customer environment name

header Parameters
Accept-Language
string or null
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
required
Array
object

Responses

Request samples

Content type
application/json
[
  • { }
]

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "errorMessage": "string",
  • "additionalInfo": [
    ]
}

Retrieves a subset of sample lines from a dataset

Returns a number of a dataset's lines alongside it's columns. The number of requested lines can be specified by the length query param, and it must be between 0 and 50.

path Parameters
datasetUid
required
string
tenant
required
string

Customer environment name

query Parameters
decimalSeparator
string
groupingSeparator
string
length
number [ 0 .. 10 ]

Decimal separator character

header Parameters
Accept-Language
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Responses

Response samples

Content type
application/json
{
  • "columns": [
    ],
  • "rows": [
    ]
}

Get Models Resource

Retrieve all the bpmn models for a given project

This endpoint provides the means to retrieve all the bpmn models belonging to a given project. As input this endpoint requires the identifier of the project we want to retrieve the models from

path Parameters
tenant
required
string
query Parameters
limit
required
integer <int32>

Page size for pagination

projectId
required
string
Example: projectId=X54Jasdw78

String corresponding to project identifier

start
required
integer <int32>

Page index for pagination

header Parameters
Accept-Language
required
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Responses

Response samples

Content type
application/json
{ }

Upload Xml Resource

Upload a BPMN file to store it

This endpoint provides the means to import a bpmn file into a project. As input this endpoint requires the identifier of the project it belongs to, the name with which the file will be stored, and the bpmn file.

path Parameters
tenant
required
string
header Parameters
Accept-Language
required
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema:
name
required
string [ 5 .. 100 ] characters
datasetUid
string or null^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}...
projectUid
required
string^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}...
required
Array of objects (ActivityDTO)
required
Array of objects (ArcDTO)

Responses

Request samples

Content type
{
  • "name": "string",
  • "datasetUid": "string",
  • "projectUid": "string",
  • "activities": [
    ],
  • "arcs": [
    ]
}

Response samples

Content type
application/json
{ }

Get Model Resource

Get the model stored by its id

This endpoint provides the means to retrieve the bpmn model information stored. As input this endpoint requires the identifier of the model we want to retrieve the information from.

path Parameters
modelId
required
string
Example: X54Jasdw78

String corresponding to model id

tenant
required
string
header Parameters
Accept-Language
required
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Responses

Response samples

Content type
application/json
{ }

Update Bpmn Model Resource

Update the stored filename for a stored bpmn model

This endpoint provides the means to change the name of a stored bpmn model. As input this endpoint requires the model identifier for which we want to change the name, and the new model name.

path Parameters
modelId
required
string
Example: X54Jasdw78

String corresponding to model id

tenant
required
string
header Parameters
Accept-Language
required
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
name
required
string [ 5 .. 100 ] characters

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{ }

Delete Model Resource

Delete a bpmn model

This endpoint provides the means to delete a bpmn model currently stored. As input this endpoint takes the identifier of the model it is intended to remove.

path Parameters
modelId
required
string
Example: X54Jasdw78

String corresponding to model id

tenant
required
string
header Parameters
Accept-Language
required
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Responses

Response samples

Content type
application/json
{ }

Root Cause Resource

Obtains the root cause information about failing traces on a given dataset compared to a stored bpmn model

This endpoint provides the means to obtain root cause information about the traces that do not fulfill a stored bpmn model. It requires to specify the attributes for which root cause must be obtained. Up to 4 attributes are accepted of categorical or boolean nature.

path Parameters
bpmnId
required
string
datasetUUID
required
string
tenant
required
string
header Parameters
Accept-Language
required
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
required
required
Array of objects or null

Represents a collections of filters

operator
required
object or null
Enum: "AND" "OR"

Operator to aggregate filters (optional). Possible values are AND/OR. Default is AND.

filterSets
required
string or null

Represents a collections of filtersets

attributes
required
Array of strings

Represents a collection of attributes to perform Root Cause over. Up to 4 attributes can be used of boolean or categorical nature

Responses

Request samples

Content type
application/json
{
  • "filters": [
    ],
  • "operator": "AND",
  • "filterSets": "string",
  • "attributes": [
    ]
}

Response samples

Content type
application/json
{ }

Obtains the root cause information about failing traces on a given dataset compared to an introduced json model

This endpoint provides the means to obtain root cause information about the traces that do not fulfill an introduced json model. It requires to specify the attributes for which root cause must be obtained. Up to 4 attributes are accepted of categorical or boolean nature.

path Parameters
datasetUUID
required
string
tenant
required
string
header Parameters
Accept-Language
required
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
required
required
Array of objects or null

Represents a collections of filters

operator
required
object or null
Enum: "AND" "OR"

Operator to aggregate filters (optional). Possible values are AND/OR. Default is AND.

filterSets
required
string or null

Represents a collections of filtersets

attributes
required
Array of strings

Represents a collection of attributes to perform Root Cause over. Up to 4 attributes can be used of boolean or categorical nature

required
object

Represents the json model to perform conformance against

Responses

Request samples

Content type
application/json
{
  • "filters": [
    ],
  • "operator": "AND",
  • "filterSets": "string",
  • "attributes": [
    ],
  • "model": {
    }
}

Response samples

Content type
application/json
{ }

Conformance Tool Resource

Obtains the conformance total and grouped by time on a given dataset by an introduced model

This endpoint provides the means to obtain the total conformance and grouped by time. As input this endpoint accepts a bpmn identifier from the currently available for the user and requires a timeSplit to group. Valid values are "day", "week" and "month".

path Parameters
bpmnId
required
string
datasetUUID
required
string
tenant
required
string
header Parameters
Accept-Language
required
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
required
timeSplit
required
string

Represents the required split time to report the conformance in. Valid values are: day, week and month

required
Array of objects or null

Represents a collections of filters

operator
required
object or null
Enum: "AND" "OR"

Operator to aggregate filters (optional). Possible values are AND/OR. Default is AND.

filterSets
required
string or null

Represents a collections of filtersets

Responses

Request samples

Content type
application/json
{
  • "timeSplit": "string",
  • "filters": [
    ],
  • "operator": "AND",
  • "filterSets": "string"
}

Response samples

Content type
application/json
{ }

Obtains the conformance on a given dataset by an introduced model

This endpoint provides the means to obtain the total conformance and grouped by time. As input this endpoint accepts a model in json format from the currently available for the user and requires a timeSplit to group. Valid values are "day", "week" and "month".

path Parameters
datasetUUID
required
string
tenant
required
string
header Parameters
Accept-Language
required
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
required
timeSplit
required
string

Represents the required split time to report the conformance in. Valid values are: day, week and month

required
Array of objects or null

Represents a collections of filters

operator
required
object or null
Enum: "AND" "OR"

Operator to aggregate filters (optional). Possible values are AND/OR. Default is AND.

filterSets
required
string or null

Represents a collections of filtersets

required
object

Represents the json model to perform conformance against

Responses

Request samples

Content type
application/json
{
  • "timeSplit": "string",
  • "filters": [
    ],
  • "operator": "AND",
  • "filterSets": "string",
  • "model": {
    }
}

Response samples

Content type
application/json
{ }

Process Violation Resource

Obtains the list of process violation by activity from an stored bpmn model 

    This endpoint provides the means to obtain the list of transition violation within a dataset for a given bpmn model. It requires to specify the type of activity "start" or "end".
path Parameters
bpmnId
required
string
datasetUUID
required
string
tenant
required
string
header Parameters
Accept-Language
required
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
required
activityType
required
string

Represents the type of activity to perform process conformance in. Valid values are: start and end.

required
Array of objects or null

Represents a collections of filters

Responses

Request samples

Content type
application/json
{
  • "activityType": "string",
  • "filters": [
    ]
}

Response samples

Content type
application/json
{ }

Obtains the list of process violation by activity from an introduced json model 

    This endpoint provides the means to obtain the list of transition violation within a dataset for a given model. As input it requires the model in json format. It is required to specify the activityType "start" or "end".
path Parameters
datasetUUID
required
string
tenant
required
string
header Parameters
Accept-Language
required
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
required
activityType
required
string

Represents the type of activity to perform process conformance in. Valid values are: start and end.

required
Array of objects or null

Represents a collections of filters

required
object

Represents the json model to perform conformance against

Responses

Request samples

Content type
application/json
{
  • "activityType": "string",
  • "filters": [
    ],
  • "model": {
    }
}

Response samples

Content type
application/json
{ }

Obtains the list of process violation by transition from a stored bpmn 

    This endpoint provides the means to obtain the list of transition violation within a dataset for a given bpmn.
path Parameters
bpmnId
required
string
datasetUUID
required
string
tenant
required
string
header Parameters
Accept-Language
required
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
required
Array of objects or null

Represents a collections of filters

operator
required
object or null
Enum: "AND" "OR"

Operator to aggregate filters (optional). Possible values are AND/OR. Default is AND.

filterSets
required
string or null

Represents a collections of filtersets

Responses

Request samples

Content type
application/json
{
  • "filters": [
    ],
  • "operator": "AND",
  • "filterSets": "string"
}

Response samples

Content type
application/json
{ }

Obtains the list of process violation by transition from an introduced json model 

    This endpoint provides the means to obtain the list of transition violation within a dataset for a given model. As input it requires the model in json format.
path Parameters
datasetUUID
required
string
tenant
required
string
header Parameters
Accept-Language
required
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
required
required
Array of objects or null

Represents a collections of filters

operator
required
object or null
Enum: "AND" "OR"

Operator to aggregate filters (optional). Possible values are AND/OR. Default is AND.

filterSets
required
string or null

Represents a collections of filtersets

required
object

Represents the json model to perform conformance against

Responses

Request samples

Content type
application/json
{
  • "filters": [
    ],
  • "operator": "AND",
  • "filterSets": "string",
  • "model": {
    }
}

Response samples

Content type
application/json
{ }

Prediction Search Resource

Retrieve the predicted cases for the dataset

This endpoint provides the means to retrieve the computed predictions of the unfinished cases of the dataset. As input this endpoint requires the identifier of the dataset we want to extract the prediction from and the page start, limit, and sort method.

path Parameters
datasetId
required
string
tenant
required
string
query Parameters
datasetId
required
string
Example: datasetId=X54Jasdw78

String corresponding to dataset identifier

header Parameters
Accept-Language
required
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
start
required
integer or null <int32>
limit
required
integer or null <int32>
sortBy
required
string
sortDirection
required
string
filterOutNewVariants
boolean

Responses

Request samples

Content type
application/json
{
  • "start": 0,
  • "limit": 0,
  • "sortBy": "string",
  • "sortDirection": "string",
  • "filterOutNewVariants": true
}

Response samples

Content type
application/json
{
  • "total": 0,
  • "risk": 0,
  • "noRisk": 0,
  • "data": [
    ],
  • "isFullResult": true,
  • "fullResult": true
}

Prediction Visual Model Resource

Retrieve the visual model for the predicted cases

This endpoint provides the means to retrieve the visual model for the predictions of the unfinished cases of the dataset. As input this endpoint requires the identifier of the dataset we want to extract the prediction from, the unfinished trace we want to visualize and the page start, limit, and sort method.

path Parameters
datasetId
required
string
traceId
required
string
tenant
required
string
query Parameters
datasetId
required
string
Example: datasetId=X54Jasdw78

String corresponding to dataset identifier

traceId
required
string
Example: traceId=X54Jasdw78

String corresponding to trace identifier

header Parameters
Accept-Language
required
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "data": [
    ]
}

Activities - Arcs origin and destination

Returns the set of arcs which have as origin or as destination the indicated activity 

    Obtains the set of activities for a specific dataset which have as origin or as destination the indicated activity.
    This endpoint allows filtering by a set of [InputFilterDTO],
    and the result will contain only the arcs present in the filtered subset of traces.
path Parameters
activityId
required
string or null
datasetUid
required
string or null
tenant
required
string or null

Customer environment name

header Parameters
Accept-Language
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
Array of objects or null

Represents a collections of filters

operator
string or null
Enum: "AND" "OR"

Operator to aggregate filters (optional). Possible values are AND/OR. Default is AND.

filterSets
Array of strings or null

Represents a collections of filtersets

Responses

Request samples

Content type
application/json
{
  • "filters": [
    ],
  • "operator": "AND",
  • "filterSets": [
    ]
}

Response samples

Content type
application/json
{
  • "origin": [
    ],
  • "destination": [
    ]
}

Management - Alerts

Obtains visualization info of alerts for a specific dataset 

                This endpoint allows the retrieval and search of visualization info of alerts for a dataset.
path Parameters
datasetUid
required
string or null
tenant
required
string or null

Customer environment name

header Parameters
Accept-Language
string or null
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
required
Array of objects or null (InputFilterDTO)
operator
required
string or null
filterSets
required
Array of strings or null
arcs
boolean or null

Responses

Request samples

Content type
application/json
{
  • "filters": [
    ],
  • "operator": "string",
  • "filterSets": [
    ],
  • "arcs": true
}

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "errorMessage": "string",
  • "additionalInfo": [
    ]
}

Management - Datasets - Performance Booster

Returns a list of values of the attribute lead times plot in the Performance Booster. 

                Returns a list of values of the attribute lead times plot filtered by one specific attribute in the Performance Booster
path Parameters
datasetUid
required
string or null
tenant
required
string or null

Customer environment name

header Parameters
Accept-Language
string or null
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
attribute
string or null
activities
Array of strings or null
transitions
Array of strings or null
variants
Array of strings or null
sortBy
string or null
sortDirection
string or null
limit
integer or null <int32>

Responses

Request samples

Content type
application/json
{
  • "attribute": "string",
  • "activities": [
    ],
  • "transitions": [
    ],
  • "variants": [
    ],
  • "sortBy": "string",
  • "sortDirection": "string",
  • "limit": 0
}

Response samples

Content type
application/json
{
  • "rows": [
    ]
}

Returns a list of values of the attribute performance comparison plot in the Performance Booster. 

                Returns a list of values of the attribute performance comparison plot filtered by one specific attribute in the Performance Booster
path Parameters
datasetUid
required
string or null
tenant
required
string or null

Customer environment name

header Parameters
Accept-Language
string or null
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
attribute
string or null
activities
Array of strings or null
transitions
Array of strings or null
variants
Array of strings or null
sortBy
string or null
sortDirection
string or null
limit
integer or null <int32>

Responses

Request samples

Content type
application/json
{
  • "attribute": "string",
  • "activities": [
    ],
  • "transitions": [
    ],
  • "variants": [
    ],
  • "sortBy": "string",
  • "sortDirection": "string",
  • "limit": 0
}

Response samples

Content type
application/json
{
  • "categoricalRows": [
    ],
  • "numericalRows": [
    ],
  • "data": {
    }
}

Returns a list of average durations grouped by week/month for values of an specific attribute. 

                Returns a list of average durations grouped by week/month for values of an specific attribute.
path Parameters
datasetUid
required
string or null
tenant
required
string or null

Customer environment name

header Parameters
Accept-Language
string or null
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
attribute
string or null
activities
Array of strings or null
transitions
Array of strings or null
variants
Array of strings or null
temporalUnit
string or null
limit
integer or null <int32>

Responses

Request samples

Content type
application/json
{
  • "attribute": "string",
  • "activities": [
    ],
  • "transitions": [
    ],
  • "variants": [
    ],
  • "temporalUnit": "string",
  • "limit": 0
}

Response samples

Content type
application/json
{
  • "sla": 0,
  • "rows": [
    ]
}

Prediction highlights in the Performance Booster.

Return a list of KPIs that represent the prediction highlights in the Performance Booster

path Parameters
datasetUid
required
string or null
tenant
required
string or null

Customer environment name

query Parameters
filterOutNewVariants
boolean or null
header Parameters
Accept-Language
required
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Responses

Response samples

Content type
application/json
{
  • "meetSlaAbsolute": 0,
  • "meetSlaPercentage": 0.1,
  • "riskSlaAbsolute": 0,
  • "riskSlaPercentage": 0.1,
  • "exceedSlaAbsolute": 0,
  • "exceedSlaPercentage": 0.1,
  • "isFullResult": true,
  • "fullResult": true
}

Returns a list of values of the Lead Times plot in the Performance Booster. 

                Returns a list of values of the Lead Times by activity/transition/variant plot in the Performance Booster
path Parameters
datasetUid
required
string or null
tenant
required
string or null

Customer environment name

header Parameters
Accept-Language
string or null
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
content
string or null
sortBy
string or null
sortDirection
string or null
limit
integer or null <int32>

Responses

Request samples

Content type
application/json
{
  • "content": "string",
  • "sortBy": "string",
  • "sortDirection": "string",
  • "limit": 0
}

Response samples

Content type
application/json
{
  • "rows": [
    ]
}

Predicted performance for ongoing cases in the Performance Booster. 

        Return a list of predicted performances for the ongoing cases in the Performance Booster.
        
        The list contains for each ongoing case the caseId, the current duration, the estimated duration and 
        the state. This list can be filtered by a pair of attribute-value.
path Parameters
datasetUid
required
string or null
tenant
required
string or null

Customer environment name

header Parameters
Accept-Language
string or null
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
attribute
string or null
value
string or null
start
integer or null <int32>
limit
integer or null <int32>
filterOutNewVariants
boolean or null

Responses

Request samples

Content type
application/json
{
  • "attribute": "string",
  • "value": "string",
  • "start": 0,
  • "limit": 0,
  • "filterOutNewVariants": true
}

Response samples

Content type
application/json
{
  • "total": 0,
  • "rows": [
    ]
}

Overall performance in the Performance Booster. 

                Returns a list of values of the overall performance in the Performance Booster. 
                This performance can be filtered from the values of the categorical attributes of the dataset.
                
                It also returns two KPI, representing the percentage of traces that are valid to de dataset SLA, and 
                the percentage of tracer that are not valid.
path Parameters
datasetUid
required
string or null
tenant
required
string or null

Customer environment name

header Parameters
Accept-Language
string or null
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
attribute
string or null
value
string or null
timeGroups
integer or null <int32>

Responses

Request samples

Content type
application/json
{
  • "attribute": "string",
  • "value": "string",
  • "timeGroups": 0
}

Response samples

Content type
application/json
{
  • "rows": [
    ],
  • "kpis": {
    }
}

Returns a list of values of the performance by content plot in the Performance Booster. 

                Returns a list of values of the performance by activity/transition/variant plot in the Performance Booster
path Parameters
datasetUid
required
string or null
tenant
required
string or null

Customer environment name

header Parameters
Accept-Language
string or null
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
content
string or null
sortBy
string or null
sortDirection
string or null
limit
integer or null <int32>

Responses

Request samples

Content type
application/json
{
  • "content": "string",
  • "sortBy": "string",
  • "sortDirection": "string",
  • "limit": 0
}

Response samples

Content type
application/json
{
  • "categoricalRows": [
    ],
  • "numericalRows": [
    ],
  • "data": {
    }
}

Predicted duration by attribute in the Performance Booster. 

        Return a list of predicted durations for a selected attribute in the Performance Booster.
        
        The list is formed by all the different values of the attribute with its corresponding average current duration
        and average predicted duration.
path Parameters
datasetUid
required
string or null
tenant
required
string or null

Customer environment name

header Parameters
Accept-Language
string or null
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
attribute
required
string
pastTime
integer or null <int32>
filterOutNewVariants
boolean or null

Responses

Request samples

Content type
application/json
{
  • "attribute": "string",
  • "pastTime": 0,
  • "filterOutNewVariants": true
}

Response samples

Content type
application/json
{
  • "rows": [
    ]
}

Predicted performance by attribute in the Performance Booster. 

        Return a list of predicted performances for a selected attribute in the Performance Booster.
        
        The list is formed for each value of the selected attribute, the number of cases under and above SLA for 
        finished cases and for the ongoing cases based on their estimated duration.
path Parameters
datasetUid
required
string or null
tenant
required
string or null

Customer environment name

header Parameters
Accept-Language
string or null
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
attribute
required
string
pastTime
integer or null <int32>
filterOutNewVariants
boolean or null

Responses

Request samples

Content type
application/json
{
  • "attribute": "string",
  • "pastTime": 0,
  • "filterOutNewVariants": true
}

Response samples

Content type
application/json
{
  • "rows": [
    ]
}

Predicted risk by attribute in the Performance Booster. 

        Return a list of predicted risks for a selected attribute in the Performance Booster.
        
        The list is formed by all the different values of the attribute with its corresponding absolute and percentage
        risk values.
path Parameters
datasetUid
required
string or null
tenant
required
string or null

Customer environment name

header Parameters
Accept-Language
string or null
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
attribute
required
string
filterOutNewVariants
boolean or null

Responses

Request samples

Content type
application/json
{
  • "attribute": "string",
  • "filterOutNewVariants": true
}

Response samples

Content type
application/json
{
  • "rows": [
    ]
}

Summary text the Prediction Performance Booster. 

                Returns a text that resumes the most important points of the Prediction Performance Booster.
path Parameters
datasetUid
required
string or null
Example: X54Jasdw78

String corresponding to DATASET id

tenant
required
string or null

Customer environment name

header Parameters
Accept-Language
string or null
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
format
string or null
filterOutNewVariants
boolean or null

Responses

Request samples

Content type
application/json
{
  • "format": "string",
  • "filterOutNewVariants": true
}

Response samples

Content type
application/json
{
  • "analysisReport": "string"
}

Summary text the State Performance Booster. 

                Returns a text that resumes the most important points of the State Performance Booster.
path Parameters
datasetUid
required
string or null
Example: X54Jasdw78

String corresponding to DATASET id

tenant
required
string or null

Customer environment name

header Parameters
Accept-Language
string or null
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
format
string or null

Responses

Request samples

Content type
application/json
{
  • "format": "string"
}

Response samples

Content type
application/json
{
  • "analysisReport": "string"
}

Time to meet in the Performance Booster. 

        Return a list of times to meet for a selected attribute in the Performance Booster.
        
        The list is formed by all the different values of the attribute with its corresponding time to meet the best 
        value of the attribute or the SLA.
path Parameters
datasetUid
required
string or null
tenant
required
string or null

Customer environment name

header Parameters
Accept-Language
string or null
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
attribute
required
string
mode
required
string
timeInterval
integer <int32>
filterOutNewVariants
boolean or null

Responses

Request samples

Content type
application/json
{
  • "attribute": "string",
  • "mode": "string",
  • "timeInterval": 0,
  • "filterOutNewVariants": true
}

Response samples

Content type
application/json
{
  • "rows": [
    ]
}

Summary text the WhatIf Performance Booster. 

                Returns a text that resumes the most important points of the WhatIf Performance Booster.
path Parameters
datasetUid
required
string or null
Example: X54Jasdw78

String corresponding to DATASET id

tenant
required
string or null

Customer environment name

header Parameters
Accept-Language
string or null
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
format
string or null

Responses

Request samples

Content type
application/json
{
  • "format": "string"
}

Response samples

Content type
application/json
{
  • "analysisReport": "string"
}

List activities and transitions filtered by attribute in the WhatIf Booster. 

        Return a list of activities and transitions with its total time and cost
        with possibility to be filtered by attribute in the WhatIf Booster.
path Parameters
datasetUid
required
string or null
tenant
required
string or null

Customer environment name

header Parameters
Accept-Language
string or null
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
Array of objects or null (AttributeValueDTO)

Responses

Request samples

Content type
application/json
{
  • "attributes": [
    ]
}

Response samples

Content type
application/json
{
  • "logger": { },
  • "environment": "string",
  • "token": { },
  • "usersFacade": { },
  • "datasetsFacade": { },
  • "whatIfBoosterFacade": {
    },
  • "configurationsFacade": {
    }
}

List improved activities and transitions possibly filtered by attribute in the WhatIf Booster. 

        Return a list of improved activities and transitions with its total time and cost
        with possibility to be filtered by attribute in the WhatIf Booster.
path Parameters
datasetUid
required
string or null
tenant
required
string or null

Customer environment name

header Parameters
Accept-Language
string or null
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
Array of objects or null (ActivityImprovementDTO)
Array of objects or null (TransitionImprovementDTO)
Array of objects or null (AttributeValueDTO)

Responses

Request samples

Content type
application/json
{
  • "activitiesImprovement": [
    ],
  • "transitionsImprovement": [
    ],
  • "attributes": [
    ]
}

Response samples

Content type
application/json
{
  • "logger": { },
  • "environment": "string",
  • "token": { },
  • "usersFacade": { },
  • "datasetsFacade": { },
  • "whatIfBoosterFacade": {
    },
  • "configurationsFacade": {
    }
}

Regenerate Metrics Resource

Manually regenerate process metrics zip

This endpoint triggers regeneration of process metrics zip file. Can be useful for datasets that were created before an update

path Parameters
datasetUid
required
string

String corresponding to a datasetUid

tenant
required
string
header Parameters
Accept-Language
required
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Responses

Response samples

Content type
application/json
{ }

Ingest - File Upload

Upload a CSV file to update an existing dataset 

        This endpoint provides the means to import new data into a dataset. As input this endpoint accepts
        any valid csv file and required the use of an single use upload token which has to be requested
        using the operation updates/initiate.
path Parameters
datasetUid
required
string

ID of the targeted dataset

tenant
required
string

Customer environment name

token
required
string
header Parameters
Accept-Language
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

fileName
string

File name

Request Body schema: application/octet-stream
any (File)

Responses

Upload a CSV file for a dataset 

        This endpoint provides the means to import data into a dataset. As input this endpoint accepts
        any valid csv file and required the use of an single use upload token which has to be requested
        using the operation uploads/initiate.
path Parameters
datasetUid
required
string

ID of the targeted dataset

tenant
required
string

Customer environment name

token
required
string
header Parameters
Accept-Language
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

fileName
string

File name

Request Body schema: application/octet-stream
any (File)

Responses

Finishes the upload of a datasets, initiating the parsing 

    This service must be called to start the asynchronous processing of the dataset update once the update file has been uploaded calling /uploads/datasets/update/{datasetUid} with an upload token. Once started, the state of the process can be accessed in the dataset by calling /datasets or /datasets/{datasetUid}.
path Parameters
datasetUid
required
string or null
tenant
required
string or null

Customer environment name

header Parameters
Accept-Language
string or null
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Responses

Response samples

Content type
application/json
{
  • "columns": [
    ],
  • "rows": [
    ]
}

Finishes the upload of a datasets, initiating the parsing

This service must be called to start the asynchronous processing of the dataset once the file has been uploaded calling /uploads/{datasetUid} with an upload token. Once started, the state of the process can be accessed in the dataset by calling /datasets or /datasets/{datasetUid}.

path Parameters
datasetUid
required
string
tenant
required
string

Customer environment name

header Parameters
Accept-Language
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Responses

Response samples

Content type
application/json
{
  • "columns": [
    ],
  • "rows": [
    ]
}

Generates an one time use upload token for the user

Generated a token that allows the call to /uploads/{datasetUid} to upload a file. This token has a longer life time to avoid expiration during the upload for big files.

path Parameters
datasetUid
required
string
tenant
required
string

Customer environment name

header Parameters
Accept-Language
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Responses

Response samples

Content type
application/json
{
  • "token": "string"
}

Powerbi - Download

Download the .pbix file for Power Bi Desktop

path Parameters
tenant
required
string or null

Customer environment name

header Parameters
Accept-Language
string or null
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Responses

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "errorMessage": "string",
  • "additionalInfo": [
    ]
}

Management - Users

Returns information about the user who made the request

path Parameters
tenant
required
string

Customer environment name

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "surname": "string",
  • "email": "string",
  • "locale": "string",
  • "locationFormat": "string",
  • "timezone": "string",
  • "subscription": { },
  • "theme": "string",
  • "llmEnabled": true,
  • "mlEnabled": true
}

Update the user profile information

path Parameters
tenant
required
string

Customer environment name

header Parameters
Accept-Language
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
required
name
string or null
surname
string or null
email
string or null
locale
string or null
locationFormat
string or null

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "surname": "string",
  • "email": "string",
  • "locale": "string",
  • "locationFormat": "string"
}

Returns the user api token

path Parameters
tenant
required
string

Customer environment name

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "data": [
    ]
}

Updates the user api token

path Parameters
tenant
required
string

Customer environment name

header Parameters
Accept-Language
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Cancels the current user api token

path Parameters
tenant
required
string

Customer environment name

Responses

Reset users password

path Parameters
tenant
required
string

Customer environment name

Responses

Retrieves the invitations associated with an organization for the current user

path Parameters
tenant
required
string or null

Customer environment name

query Parameters
endDate
string or null <yyyy-mm-dd>

Final lookup date

limit
number [ 1 .. 100 ]

Page size for pagination

organizationUid
required
string or null <uuid> [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

The organization unique identifier (UID)

start
integer or null <int32>

Page index for pagination

startDate
string or null <yyyy-mm-dd>

Initial lookup date

status
string or null

Filter user invitations by their status

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "data": [
    ],
  • "maxInvitations": 0
}

Registers a new invitation for an user to join a organization

path Parameters
tenant
required
string

Customer environment name

header Parameters
Accept-Language
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
required
organizationUid
required
string <uuid> [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

Organization identifier (UUID)

email
required
string

Invitation receiver

Responses

Request samples

Content type
application/json
{
  • "organizationUid": "fea6b182-b1a9-4014-b0cc-e1c342c76389",
  • "email": "string"
}

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "errorMessage": "string",
  • "additionalInfo": [
    ]
}

Cancels a user invitation

path Parameters
tenant
required
string

Customer environment name

userInvitationUid
required
string

The user invitation UID

Responses

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "errorMessage": "string",
  • "additionalInfo": [
    ]
}

Revokes a user invitation

path Parameters
tenant
required
string

Customer environment name

userInvitationUid
required
string

The user invitation UID

Responses

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "errorMessage": "string",
  • "additionalInfo": [
    ]
}

Management - Notifications

Retrieves the notifications associated with an organization for the current user

path Parameters
tenant
required
string or null

Customer environment name

query Parameters
alreadySeen
boolean or null

Include already seen notifications

endDate
string or null <yyyy-mm-dd>

Final lookup date

limit
number [ 1 .. 100 ]

Page size for pagination

organizationUid
required
string or null <uuid> [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

The organization unique identifier (UID)

start
integer or null <int32>

Page index for pagination

startDate
string or null <yyyy-mm-dd>

Initial lookup date

header Parameters
Accept-Language
required
string

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "data": [
    ]
}

Marks a notifications as Already seen

path Parameters
notificationUid
required
string
tenant
required
string

Customer environment name

Responses

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "errorMessage": "string",
  • "additionalInfo": [
    ]
}

Management - Organizations

Retrieves all organizations accessible by the user who made the request

This endpoints provides the means to retrieve the collection of organizations accessible to the user, it includes the organizations registered by the user and the ones where the user is invited as collaborator.

path Parameters
tenant
required
string

Customer environment name

query Parameters
limit
integer <int32>

Page size for pagination

onlyActive
boolean

Include delete organizations

search
string

Filter by dataset's name (partial and case insensitive)

shared
boolean

Get owned or shared organizations

sortBy
string

Sort criteria: CREATED_AT or NAME

sortDirection
string

Sort direction: ASCENDING or DESCENDING

start
integer <int32>

Page index for pagination

header Parameters
Accept-Language
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Responses

Response samples

Content type
application/json
{ }

Register a new organization associated to the user who made the request

path Parameters
tenant
required
string

Customer environment name

header Parameters
Accept-Language
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
required
name
required
string [ 5 .. 100 ] characters (?U)^[\w\-\s]+$

Organization name

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "errorMessage": "string",
  • "additionalInfo": [
    ]
}

Retrieves an organization accessible by the user who made the request

path Parameters
organizationUid
required
string

The project's UID

tenant
required
string

Customer environment name

Responses

Response samples

Content type
application/json
{ }

Updates an user-owned organization

path Parameters
organizationUid
required
string

The project's UID

tenant
required
string

Customer environment name

header Parameters
Accept-Language
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
required
name
required
string [ 5 .. 100 ] characters (?U)^[\w\-\s]+$

Organization name

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "errorMessage": "string",
  • "additionalInfo": [
    ]
}

Deletes an user-owned organization

path Parameters
organizationUid
required
string

The project's UID

tenant
required
string

Customer environment name

Responses

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "errorMessage": "string",
  • "additionalInfo": [
    ]
}

Management - Projects

Retrieves the projects that belong to an organization accessible by the current user

path Parameters
tenant
required
string or null

Customer environment name

query Parameters
includeArchived
boolean or null

Include archived projects

limit
integer or null <int32>

Page size for pagination

organizationUid
required
string or null <uuid> [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

The organization unique identifier (UID)

search
string or null

Sort direction: ASCENDING of DESCENDING

sortBy
string or null
sortDirection
string or null
start
integer or null <int32>

Page index for pagination

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "data": [
    ]
}

Creates a new empty project inside an organization

path Parameters
tenant
required
string

Customer environment name

header Parameters
Accept-Language
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
required
name
required
string [ 5 .. 100 ] characters
description
string or null [ 0 .. 500 ] characters
organizationUid
required
string^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}...

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "organizationUid": "string"
}

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "errorMessage": "string",
  • "additionalInfo": [
    ]
}

Retrieves a project by its unique identifier (UUID)

path Parameters
projectUid
required
string

The project unique identifier

tenant
required
string

Customer environment name

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "data": [
    ]
}

Updates project public information

path Parameters
projectUid
required
string

The project's UID

tenant
required
string

Customer environment name

header Parameters
Accept-Language
string
Example: en-GB, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Standard language tag rfc5646 compliant

Request Body schema: application/json
required
name
string or null [ 5 .. 100 ] characters
description
string or null [ 0 .. 500 ] characters

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "errorMessage": "string",
  • "additionalInfo": [
    ]
}

Archive a project by its unique identifier (UID), archived project will be accessible in read-only mode

path Parameters
projectUid
required
string
tenant
required
string

Customer environment name

Responses

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "errorMessage": "string",
  • "additionalInfo": [
    ]
}

Authentication

Obtain an access token from an offline token

Obtains a new access token, refresh token and metadata using an offline token previously emmited

This endpoint uses grant_type=refresh_token.
Keycloak accepts an offline token as "refresh_token" to generate access tokens even without an active session.

path Parameters
realm
required
string

Keycloak realm name. For the public platform is processmining

Request Body schema: application/x-www-form-urlencoded
required
client_id
required
string
Value: "processmining-frontend"
grant_type
required
string
Value: "refresh_token"
refresh_token
required
string

Offline token

Responses

Response samples

Content type
application/json
{
  • "access_token": "string",
  • "expires_in": 0,
  • "refresh_expires_in": 0,
  • "refresh_token": "string",
  • "token_type": "Bearer",
  • "session_state": "string",
  • "scope": "string"
}