API docs by Redocly

(v0)

Download OpenAPI specification:Download

Inverbis Analytics contact: developers@inverbisanalytics.com URL: https://web.inverbisanalytics.com/contacto/ License: Inverbis General License Terms of Service

Inverbis Analytics public API

This API provides access to all the feature provided by the Inverbis Analytics platform to consumers across the different environments public and private managed by the Inverbis team.

This API follows path-based versioning strategy. Data will always remain backwards compatible, API contracts are guaranteed backwards compatible during a year since the release date.

Customer with private and isolated Inverbis Analytics environments must use the path parameter {tenant}, to provide their environment name in order to able to access their exclusive environment, apart from using their unique server address. Public users need to inform this parameter with the value processmining, which is the name of the default public environment.

API Design

Three independent modules group related apis into functional areas that can be accessed for different use cases:

  • Ingest: This module provide access to services that allow consumers to add new events to their existing datasets or event logs. By this API it is possible to schedule periodic ETL task to allow the Inverbis platform to automatically retrieve information from your systems.

  • Management: This API provides consumers with features that allow them to manage their Users, environments , projects, or payments.

  • Exploration: This module provides access to services that allow consumers to explore their process logs and explore their data to find useful insights and retrieve all the additional information generated by the Inverbis platform.

Exploration - Views

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.

Authorizations:
InverbisOauth2
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
datasetUid
required
string <uuid> non-empty [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

Represents the data set universal identifier where the activities will be searched

Array of objects or null

Optional filters to constraint the data taken into consideration for the view generation

limit
required
integer <int32> [ 0 .. 100 ]
Default: "10"

Number of variants to return

sortBy
required
string non-empty
Enum: "DURATION_AVG" "DURATION_MAX" "DURATION_MIN" "DURATION_STD" "FREQUENCY"

Field to sort by the variants

sortDirection
string
Default: "DESCENDING"
Enum: "ASCENDING" "DESCENDING"

Sorting direction

Responses

Request samples

Content type
application/json
{
  • "datasetUid": "88cd63b7-81dd-4693-81ae-38160adedffc",
  • "filters": [
    ],
  • "limit": "10",
  • "sortBy": "DURATION_AVG",
  • "sortDirection": "ASCENDING"
}

Response samples

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

Returns information associated with a conformance query result

This endpoint allows the retrieval of all information associated with a finished conformance query. The response includes the following fields:

  • query: Defined model for the conformance query
  • restrictions: Defined restrictions for the conformance query
  • compliantTraces: Number of traces that comply with the query
  • compliantTracesPercentage: Percentage of traces that comply with the query
  • nonCompliantTraces: Number of traces that do not comply with the query
  • nonCompliantTracesPercentage: Percentage of traces that do not comply with the query
  • averageFitness: Fitness defines the degree of compliance of a trace. In many cases this value is equal to compliantTracesPercentage
Authorizations:
InverbisOauth2
path Parameters
conformanceUid
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
{
  • "averageFitness": 0,
  • "compliantTraces": 0,
  • "compliantTracesPercentage": 0,
  • "nonCompliantTraces": 0,
  • "nonCompliantTracesPercentage": 0,
  • "query": "string",
  • "restrictions": "string"
}

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.

Authorizations:
InverbisOauth2
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
datasetUid
required
string <uuid> non-empty [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

Represents the dataset universal identifier

Array of objects or null

Optional filters to constraint the data taken into consideration for the view generation

limit
required
integer <int32> [ 0 .. 100 ]
Default: "10"

Number of elements to return

sortBy
required
string non-empty
Enum: "DURATION_AVG" "DURATION_MAX" "DURATION_MIN" "DURATION_STD" "FREQUENCY"

Field to sort by the elements

sortDirection
string
Default: "DESCENDING"
Enum: "ASCENDING" "DESCENDING"

Sorting direction

Responses

Request samples

Content type
application/json
{
  • "datasetUid": "88cd63b7-81dd-4693-81ae-38160adedffc",
  • "filters": [
    ],
  • "limit": "10",
  • "sortBy": "DURATION_AVG",
  • "sortDirection": "ASCENDING"
}

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.

Authorizations:
InverbisOauth2
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
Array of objects [ 1 .. 5 ] items

Dimensions to compare to

required
object

Dimension base to compare with

datasetUid
required
string <uuid> non-empty [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

Represents the data set universal identifier where the variants will be searched

Array of objects or null

Optional filters to constraint the data taken into consideration for the view generation

limit
required
integer <int32> [ 0 .. 100 ]
Default: "10"

Number of variants to return

sortDirection
string
Default: "DESCENDING"
Enum: "ASCENDING" "DESCENDING"

Sorting direction

Responses

Request samples

Content type
application/json
{
  • "additionalDimensions": [
    ],
  • "baseDimension": {
    },
  • "datasetUid": "88cd63b7-81dd-4693-81ae-38160adedffc",
  • "filters": [
    ],
  • "limit": "10",
  • "sortDirection": "ASCENDING"
}

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.

Authorizations:
InverbisOauth2
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
datasetUid
required
string <uuid> non-empty [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

Represents the data set universal identifier where the variants will be searched

Array of objects or null

Optional filters to constraint the data taken into consideration for the view generation

limit
required
integer <int32> [ 0 .. 100 ]
Default: "10"

Number of variants to return

sortBy
required
string non-empty
Enum: "DURATION_AVG" "DURATION_MAX" "DURATION_MIN" "DURATION_STD" "FREQUENCY"

Field to sort by the variants

sortDirection
string
Default: "DESCENDING"
Enum: "ASCENDING" "DESCENDING"

Sorting direction

Responses

Request samples

Content type
application/json
{
  • "datasetUid": "88cd63b7-81dd-4693-81ae-38160adedffc",
  • "filters": [
    ],
  • "limit": "10",
  • "sortBy": "DURATION_AVG",
  • "sortDirection": "ASCENDING"
}

Response samples

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

Management - Organizations

Organization is top administrative element to group and manage projects, users who belong to an organization in order to be able access projects and other related data.

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.

Authorizations:
InverbisOauth2
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

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
{
  • "data": [
    ],
  • "total": 0
}

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

Authorizations:
InverbisOauth2
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
name
required
string [ 5 .. 100 ] characters

Organization name

<init>
required
string [ 5 .. 100 ] characters

Organization name

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "<init>": "string"
}

Response samples

Content type
application/json
{
  • "additionalInfo": [
    ],
  • "code": "string",
  • "message": "string"
}

Retrieves an organization accessible by the user who made the request

Authorizations:
InverbisOauth2
path Parameters
organizationUid
required
string

The project's UID

tenant
required
string

Customer environment name

Responses

Response samples

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

Updates an user-owned organization

Authorizations:
InverbisOauth2
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
name
required
string [ 5 .. 100 ] characters

Organization name

<init>
required
string [ 5 .. 100 ] characters

Organization name

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "<init>": "string"
}

Response samples

Content type
application/json
{
  • "additionalInfo": [
    ],
  • "code": "string",
  • "message": "string"
}

Deletes an user-owned organization

Authorizations:
InverbisOauth2
path Parameters
organizationUid
required
string

The project's UID

tenant
required
string

Customer environment name

Responses

Response samples

Content type
application/json
{
  • "additionalInfo": [
    ],
  • "code": "string",
  • "message": "string"
}

Management - Projects

Projects are individual units of work meant to be used as a mechanism to group related datasets to develop a task using the platform functionalities such as discovery models os search relevant traces. Every project has an unique user-friendly code inside this organization which can be used to refer to it by the users.

Finished projects can be archived for safekeeping and to allow a read-only access, archived project will not appear by default.

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

Authorizations:
InverbisOauth2
path Parameters
tenant
required
string

Customer environment name

query Parameters
includeArchived
boolean

Include archived projects

limit
integer <int32>

Page size for pagination

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

The organization unique identifier (UID)

search
string

Filter by project's name and/or code (partial and case insensitive)

start
integer <int32>

Page index for pagination

Responses

Response samples

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

Creates a new empty project inside an organization

Authorizations:
InverbisOauth2
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
description
string [ 0 .. 500 ] characters
name
string [ 5 .. 100 ] characters
organizationUid
string

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "additionalInfo": [
    ],
  • "code": "string",
  • "message": "string"
}

Retrieves a project by its unique identifier (UUID)

Authorizations:
InverbisOauth2
path Parameters
projectUid
required
string

The project unique identifier

tenant
required
string

Customer environment name

Responses

Response samples

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

Updates project public information

Authorizations:
InverbisOauth2
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
description
string [ 0 .. 500 ] characters
name
string [ 5 .. 100 ] characters

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "additionalInfo": [
    ],
  • "code": "string",
  • "message": "string"
}

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

Authorizations:
InverbisOauth2
path Parameters
projectUid
required
string
tenant
required
string

Customer environment name

Responses

Response samples

Content type
application/json
{
  • "additionalInfo": [
    ],
  • "code": "string",
  • "message": "string"
}

Management - Datasets

Datasets are collections of traces and events, a trace is a set of events related to the same execution, events contain information of an activity and the associated data specific to this trace execution.

A dataset can be interpreted differently depending on the configuration of the key fields present on it, this key fields represent the minimum information required to operate with the platform and are the following:

  • Trace identifier: This identifier is shared among events, it is used to know which events belong to which trace and specific execution.
  • Activity: This identifier should be a human readable text, identifying the operation associated with the event, it should be built around some business concept or verb.
  • Start: This is the date and time of the instant in which the event begun.
  • End (Optional): This field represent the date and time when the event finished, it is optional and when it is present it allows the application to work with the concept of event duration more precisely.

In order to allow users to do different interpretations of the same dataset depending on the field they choose to use as trace identifier and activity, we build the concept of Configuration. A configuration is a specific combination of key fields associated with an specific dataset

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.

Authorizations:
InverbisOauth2
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)

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
{
  • "data": [
    ],
  • "total": 0
}

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.

Authorizations:
InverbisOauth2
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
description
string [ 0 .. 500 ] characters
name
string [ 5 .. 100 ] characters
projectUid
string

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "additionalInfo": [
    ],
  • "code": "string",
  • "message": "string"
}

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
Authorizations:
InverbisOauth2
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.

Authorizations:
InverbisOauth2
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.

Authorizations:
InverbisOauth2
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
object (JdbcParametersDTO)

Contains the parameters required to establish a jdbc connection with a jdbc datasource

projectUid
string
workflows
Array of strings unique

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "additionalInfo": [
    ],
  • "code": "string",
  • "message": "string"
}

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.

Authorizations:
InverbisOauth2
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
object (JdbcParametersDTO)

Contains the parameters required to establish a jdbc connection with a jdbc datasource

projectUid
string
workflows
Array of strings unique

Responses

Request samples

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

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.

Authorizations:
InverbisOauth2
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.

Authorizations:
InverbisOauth2
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
connectionChain
string
database
string
driver
string (DriverTypeEnum)
Enum: "MSSQL" "MYSQL" "POSTGRESQL"
host
string
password
string
port
integer <int32>
username
string

Responses

Request samples

Content type
application/json
{
  • "connectionChain": "string",
  • "database": "string",
  • "driver": "MSSQL",
  • "host": "string",
  • "password": "string",
  • "port": 0,
  • "username": "string"
}

Response samples

Content type
application/json
{
  • "additionalInfo": [
    ],
  • "code": "string",
  • "message": "string"
}

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.

Authorizations:
InverbisOauth2
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
object (JdbcParametersDTO)

Contains the parameters required to establish a jdbc connection with a jdbc datasource

projectUid
string
workflows
Array of strings unique

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "additionalInfo": [
    ],
  • "code": "string",
  • "message": "string"
}

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

Authorizations:
InverbisOauth2
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
object (JdbcParametersDTO)

Contains the parameters required to establish a jdbc connection with a jdbc datasource

projectUid
string
workflows
Array of strings unique

Responses

Request samples

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

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.

Authorizations:
InverbisOauth2
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
projectUid
string
workflows
Array of strings unique

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "additionalInfo": [
    ],
  • "code": "string",
  • "message": "string"
}

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.

Authorizations:
InverbisOauth2
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
[
  • {
    }
]

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.

Authorizations:
InverbisOauth2
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
{
  • "data": [
    ],
  • "total": 0
}

Updates the dataset public information

Allows the update of basic information (name and description) of a specific dataset referenced by its UUID as a path param. The associated file can not be changed.

Authorizations:
InverbisOauth2
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
object (CaseCompletionDTO)

Indicates the conditions to consider the completion in a process

object (CostDTO)

Indicates the Service Level Agreement of a process

description
string [ 0 .. 500 ] characters
object (FrequencyDTO)

Indicates an update frequency for a dataset

name
string [ 5 .. 100 ] characters
predictionAlgorithm
string
object (SLADTO)

Indicates the Service Level Agreement of a process

updatesEnabled
boolean

Responses

Request samples

Content type
application/json
{
  • "caseCompletion": {
    },
  • "cost": {
    },
  • "description": "string",
  • "frequency": {
    },
  • "name": "string",
  • "predictionAlgorithm": "string",
  • "sla": {
    },
  • "updatesEnabled": true
}

Response samples

Content type
application/json
{
  • "additionalInfo": [
    ],
  • "code": "string",
  • "message": "string"
}

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

Authorizations:
InverbisOauth2
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
attributes
Array of strings
Array of objects (InputFilterDTO)
name
string

Responses

Request samples

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

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.

Authorizations:
InverbisOauth2
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.

Authorizations:
InverbisOauth2
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

Set of filters over the dataset

Array of objects or null

Represents a collections of filters

Array of objects or null

Represents a collections of filters

Responses

Request samples

Content type
application/json
{
  • "filters": [
    ],
  • "<init>": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Returns a list of all the alerts for an specific dataset 

                This endpoint returns all previously created alerts for a given dataset.
Authorizations:
InverbisOauth2
path Parameters
datasetUid
required
string
tenant
required
string

Customer environment name

query Parameters
limit
integer <int32>
start
integer <int32>
type
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

Response samples

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

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

                This endpoint a new alert for a given dataset.
Authorizations:
InverbisOauth2
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
filterSets
Array of strings
mailToCreatingUser
boolean
mailToNotify
string
mailToOtherUser
boolean
name
string
riskSLA
string (RiskSLA)
Enum: "EMPTY" "HIGH" "LOW" "MEDIUM"
severity
string (SeverityLevels)
Enum: "HIGH" "LOW" "MEDIUM"
type
string (AlertType)
Enum: "PREDICTION" "STANDARD"

Responses

Request samples

Content type
application/json
{
  • "filterSets": [
    ],
  • "mailToCreatingUser": true,
  • "mailToNotify": "string",
  • "mailToOtherUser": true,
  • "name": "string",
  • "riskSLA": "EMPTY",
  • "severity": "HIGH",
  • "type": "PREDICTION"
}

Response samples

Content type
application/json
{
  • "additionalInfo": [
    ],
  • "code": "string",
  • "message": "string"
}

Deletes multiple alerts for an specific dataset 

                This endpoint deletes multiple previously created alerts for a given dataset.
Authorizations:
InverbisOauth2
path Parameters
datasetUid
required
string
tenant
required
string

Customer environment name

query Parameters
alertIds
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

Response samples

Content type
application/json
{
  • "additionalInfo": [
    ],
  • "code": "string",
  • "message": "string"
}

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
Authorizations:
InverbisOauth2
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
dismissed
boolean
filterType
string (AlertType)
Enum: "PREDICTION" "STANDARD"
limit
integer <int32>
search
string
start
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "dismissed": true,
  • "filterType": "PREDICTION",
  • "limit": 0,
  • "search": "string",
  • "start": 0
}

Response samples

Content type
application/json
{
  • "additionalInfo": [
    ],
  • "code": "string",
  • "message": "string"
}

Deletes the list of all the alerts for an specific dataset 

                This endpoint deletes all previously created alerts for a given dataset.
Authorizations:
InverbisOauth2
path Parameters
alertId
required
string

String corresponding to alert id

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
{
  • "additionalInfo": [
    ],
  • "code": "string",
  • "message": "string"
}

Evaluates a specific alert 

                This endpoint triggers an evaluation of a dataset specific alert.
                Besides returning the evaluation result, it will be saved and can be queried on /datasets/{uid}/alerts/evaluations
Authorizations:
InverbisOauth2
path Parameters
alertUid
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
{
  • "additionalInfo": [
    ],
  • "code": "string",
  • "message": "string"
}

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.
Authorizations:
InverbisOauth2
path Parameters
datasetUid
required
string
evaluationUid
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
{
  • "additionalInfo": [
    ],
  • "code": "string",
  • "message": "string"
}

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.

Authorizations:
InverbisOauth2
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

Set of filters over the dataset

Array of objects or null

Represents a collections of filters

Array of objects or null

Represents a collections of filters

Responses

Request samples

Content type
application/json
{
  • "filters": [
    ],
  • "<init>": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Get categorical attributes

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

Authorizations:
InverbisOauth2
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": [
    ]
}

Exports all trace events from a dataset in CSV format

Authorizations:
InverbisOauth2
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
{
  • "additionalInfo": [
    ],
  • "code": "string",
  • "message": "string"
}

Exports all trace events from a dataset in CSV format

Authorizations:
InverbisOauth2
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
{
  • "additionalInfo": [
    ],
  • "code": "string",
  • "message": "string"
}

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.

Authorizations:
InverbisOauth2
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
{
  • "data": [
    ],
  • "total": 0
}

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.

Authorizations:
InverbisOauth2
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
activityColumn
required
string
Array of objects (ConfigurationDateFieldDTO) [ 3 .. 100 ] items
endTimeColumn
string or null
name
string or null [ 1 .. 100 ] characters

Name of the configuration

startTimeColumn
required
string
traceColumn
required
string

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "additionalInfo": [
    ],
  • "code": "string",
  • "message": "string"
}

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.

Authorizations:
InverbisOauth2
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
{
  • "data": [
    ],
  • "total": 0
}

Exports all trace events from a dataset in CSV format

Authorizations:
InverbisOauth2
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
{
  • "additionalInfo": [
    ],
  • "code": "string",
  • "message": "string"
}

Exports all trace arcs from a dataset in CSV format

Authorizations:
InverbisOauth2
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
{
  • "additionalInfo": [
    ],
  • "code": "string",
  • "message": "string"
}

Exports all traces from a dataset in CSV format

Authorizations:
InverbisOauth2
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
{
  • "additionalInfo": [
    ],
  • "code": "string",
  • "message": "string"
}

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

Authorizations:
InverbisOauth2
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
{
  • "data": [
    ],
  • "total": 0
}

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.

Authorizations:
InverbisOauth2
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 (InputFilterDTO) [ 1 .. 100 ] items

Collection of filters

name
required
string [ 1 .. 50 ] characters

Name of the saved filter

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "additionalInfo": [
    ],
  • "code": "string",
  • "message": "string"
}

Deletes a filter set

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

Authorizations:
InverbisOauth2
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
{
  • "additionalInfo": [
    ],
  • "code": "string",
  • "message": "string"
}

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
Authorizations:
InverbisOauth2
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
{
  • "activities": 0,
  • "arcs": 0,
  • "events": 0,
  • "traces": 0,
  • "variants": 0
}

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
Authorizations:
InverbisOauth2
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
attribute
string
eventAttribute
boolean
Array of objects (InputFilterDTO)
limit
integer <int32>
loopUid
integer <int32>
sortBy
string
start
integer <int32>
variantCount
integer <int32>
variantUid
string

Responses

Request samples

Content type
application/json
{
  • "attribute": "string",
  • "eventAttribute": true,
  • "filters": [
    ],
  • "limit": 0,
  • "loopUid": 0,
  • "sortBy": "string",
  • "start": 0,
  • "variantCount": 0,
  • "variantUid": "string"
}

Response samples

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

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
Authorizations:
InverbisOauth2
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
caseType
string
duration
string
Array of objects (InputFilterDTO)
limit
integer <int32>
loopUid
integer <int32>
start
integer <int32>
variantCount
integer <int32>
variantUid
string

Responses

Request samples

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

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].

Authorizations:
InverbisOauth2
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

Filter options

Array of objects or null

Represents a collections of filters

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

Number of aggregated variants to display

Responses

Request samples

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

Response samples

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

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
Authorizations:
InverbisOauth2
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
{
  • "additionalInfo": [
    ],
  • "code": "string",
  • "message": "string"
}

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.

Authorizations:
InverbisOauth2
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

loopUid
number or null <int32>

Represents the id of a loop

variantCount
number or null <int32> >= 1

Represents a number of variants to aggregate

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

Represents the UUID of a variant

Responses

Request samples

Content type
application/json
{
  • "filters": [
    ],
  • "loopUid": 0,
  • "variantCount": 1,
  • "variantUid": "1e379f30-d81c-4dab-903c-48ac046a18c6"
}

Response samples

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

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).

Authorizations:
InverbisOauth2
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

limit
integer or null <int32>

Page size for pagination

search
string or null

Text search by name or id

self
boolean or null

Search by name

start
integer or null <int32>

Page index for pagination

variantsId
object or null

Id of the variants containing the loops

Responses

Request samples

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

Response samples

Content type
application/json
[
  • {
    }
]

Retrieves a process loops

Authorizations:
InverbisOauth2
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

Array of objects or null

Represents a collections of filters

Responses

Request samples

Content type
application/json
{
  • "filters": [
    ],
  • "<init>": [
    ]
}

Response samples

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

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.

Authorizations:
InverbisOauth2
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
object or null

Represents an input for a service which accepts a dataset filters as optional input

variantsUids
Array of strings

Responses

Request samples

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

Response samples

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

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.

Authorizations:
InverbisOauth2
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
attributes
Array of strings or null

Represents a list of attributes to be filtered

Array of objects or null

Represents a collections of filters

limit
integer or null <int32>

Page size for pagination

search
string or null

Text search by name or id

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

Sort criteria

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

Sort direction

start
integer or null <int32>

Page index for pagination

Responses

Request samples

Content type
application/json
{
  • "attributes": [
    ],
  • "filters": [
    ],
  • "limit": 0,
  • "search": "string",
  • "sortBy": "DURATION",
  • "sortDirection": "ASCENDING",
  • "start": 0
}

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.

Authorizations:
InverbisOauth2
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
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
{
  • "additionalInfo": [
    ],
  • "code": "string",
  • "message": "string"
}

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.

Authorizations:
InverbisOauth2
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

Array of objects or null

Represents a collections of filters

Responses

Request samples

Content type
application/json
{
  • "filters": [
    ],
  • "<init>": [
    ]
}

Response samples

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

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.

Authorizations:
InverbisOauth2
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": [
    ]
}

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

Authorizations:
InverbisOauth2
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
attributes
Array of strings or null

Represents a list of attributes to be filtered

Array of objects or null

Represents a collections of filters

limit
integer or null <int32>

Page size for pagination

search
string or null

Text search by name or id

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

Sort criteria

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

Sort direction

start
integer or null <int32>

Page index for pagination

Responses

Request samples

Content type
application/json
{
  • "attributes": [
    ],
  • "filters": [
    ],
  • "limit": 0,
  • "search": "string",
  • "sortBy": "DURATION",
  • "sortDirection": "ASCENDING",
  • "start": 0
}

Response samples

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

Download events from a dataset.

Generates a CSV file with filtered traces

Authorizations:
InverbisOauth2
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
attributes
Array of strings or null

Represents a list of attributes to be filtered

Array of objects or null

Represents a collections of filters

Responses

Request samples

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

Response samples

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

Allows pushing new traces to a dataset

Authorizations:
InverbisOauth2
path Parameters
datasetUid
required
string

Dataset UUID

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
object
empty
boolean

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "additionalInfo": [
    ],
  • "code": "string",
  • "message": "string"
}

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.

Authorizations:
InverbisOauth2
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": [
    ]
}

Management - Conformance and compliance

The conformance and compliance api is designed to allow users to search for traces from a dataset which behave according to a certain behaviour expressed by a model.

Through the use of conformance queries users can analyze if their processes conform to a model, obtaining as output the set of traces which conform to the process and a report with statistics related to the average degree of conformance of the traces with the model.

With compliance queries users can check using their logs if some behaviour represented with a model and a set of restrictions is present

Retrieve the conformance executions for a given project

Authorizations:
InverbisOauth2
path Parameters
tenant
required
string

Customer environment name

query Parameters
includeArchived
boolean

Include archived conformance processes

limit
integer <int32>

Page size for pagination

projectUid
required
string

Project UID

search
string

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

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
{
  • "data": [
    ],
  • "total": 0
}

Registers the execution of a new conformance analysis

Authorizations:
InverbisOauth2
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
configurationUid
required
string <uuid> [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

Unique identifier of the key field configuration to use in this conformance analysis

minFitness
required
number <%.2f>

Minimum fitness requested, percentage of minimum similarity between the trace and the model

mode
required
string
Enum: "FAST" "STRICT_PROCESS" "STRICT_SUB_PROCESS" "RELAXED"

Search mode

required
object

Conformance model to match with the traces

Responses

Request samples

Content type
application/json
{
  • "configurationUid": "8d4fb77d-fd60-4311-abcf-149fc4f0d959",
  • "minFitness": 0,
  • "mode": "FAST",
  • "query": {
    }
}

Response samples

Content type
application/json
{
  • "additionalInfo": [
    ],
  • "code": "string",
  • "message": "string"
}

Get the conformance query modes

Authorizations:
InverbisOauth2
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
[
  • {
    }
]

Retrieve a conformance execution by its UID

Authorizations:
InverbisOauth2
path Parameters
conformanceUid
required
string

Identifier of the conformance analysis

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
{
  • "data": [
    ],
  • "total": 0
}

Updates the public information of the conformance execution

Authorizations:
InverbisOauth2
path Parameters
conformanceUid
required
string

Identifier of the conformance analysis

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
description
string or null [ 0 .. 500 ] characters [ 0 .. 500 ]

User-given conformance query description

name
required
string [ 5 .. 100 ] characters [ 5 .. 100 ]

User-given conformance query name

Responses

Request samples

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

Archives a conformance process by its UUID

Authorizations:
InverbisOauth2
path Parameters
conformanceUid
required
string

Identifier of the conformance analysis

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
{
  • "additionalInfo": [
    ],
  • "code": "string",
  • "message": "string"
}

Cancels the execution of a non-finished conformance analysis

Authorizations:
InverbisOauth2
path Parameters
conformanceUid
required
string

Identifier of the conformance analysis to be cancelled

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
{
  • "additionalInfo": [
    ],
  • "code": "string",
  • "message": "string"
}

Downloads the conformance results as a csv attachment

Authorizations:
InverbisOauth2
path Parameters
conformanceUid
required
string

The conformance 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
{
  • "additionalInfo": [
    ],
  • "code": "string",
  • "message": "string"
}

Management - Users

This api allows users to invite other participants to join their organizations and share work with them. In order to add an user to an organization, it is required to create and invitation, and the user must accept it by joining the organization.

Returns information about the user who made the request

Authorizations:
InverbisOauth2
path Parameters
tenant
required
string

Customer environment name

Responses

Response samples

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

Update the user profile information

Authorizations:
InverbisOauth2
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
email
string
locale
string
locationFormat
string
name
string
surname
string

Responses

Request samples

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

Returns the user api token

Authorizations:
InverbisOauth2
path Parameters
tenant
required
string

Customer environment name

Responses

Response samples

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

Updates the user api token

Authorizations:
InverbisOauth2
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
token
string
<init>
string

New UserApiToken

Responses

Request samples

Content type
application/json
{
  • "token": "string",
  • "<init>": "string"
}

Cancels the current user api token

Authorizations:
InverbisOauth2
path Parameters
tenant
required
string

Customer environment name

Responses

Reset users password

Authorizations:
InverbisOauth2
path Parameters
tenant
required
string

Customer environment name

Responses

Retrieves the url required to provide access to a customer to his stripe portal session

Authorizations:
InverbisOauth2
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

Re activates an user cancelled subscription

Authorizations:
InverbisOauth2
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

Cancels an active users subscription

Authorizations:
InverbisOauth2
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

Retrieves the invitations associated with an organization for the current user

Authorizations:
InverbisOauth2
path Parameters
tenant
required
string

Customer environment name

query Parameters
endDate
string <yyyy-mm-dd>

Final lookup date

limit
number [ 1 .. 100 ]

Page size for pagination

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

The organization unique identifier (UID)

start
integer <int32>

Page index for pagination

startDate
string <yyyy-mm-dd>

Initial lookup date

status
string

Filter user invitations by their status

Responses

Response samples

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

Registers a new invitation for an user to join a organization

Authorizations:
InverbisOauth2
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
email
required
string

Invitation receiver

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

Organization identifier (UUID)

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "additionalInfo": [
    ],
  • "code": "string",
  • "message": "string"
}

Cancels a user invitation

Authorizations:
InverbisOauth2
path Parameters
tenant
required
string

Customer environment name

userInvitationUid
required
string

The user invitation UID

Responses

Response samples

Content type
application/json
{
  • "additionalInfo": [
    ],
  • "code": "string",
  • "message": "string"
}

Revokes a user invitation

Authorizations:
InverbisOauth2
path Parameters
tenant
required
string

Customer environment name

userInvitationUid
required
string

The user invitation UID

Responses

Response samples

Content type
application/json
{
  • "additionalInfo": [
    ],
  • "code": "string",
  • "message": "string"
}

Management - Notifications

Notifications are messages meant to be seen by specific users, and can be marked as seen to dismiss them.

Retrieves the notifications associated with an organization for the current user

Authorizations:
InverbisOauth2
path Parameters
tenant
required
string

Customer environment name

query Parameters
alreadySeen
boolean

Include already seen notifications

endDate
string <yyyy-mm-dd>

Final lookup date

limit
number [ 1 .. 100 ]

Page size for pagination

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

The organization unique identifier (UID)

start
integer <int32>

Page index for pagination

startDate
string <yyyy-mm-dd>

Initial lookup date

header Parameters
Accept-Language
string

Responses

Response samples

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

Marks a notifications as Already seen

Authorizations:
InverbisOauth2
path Parameters
notificationUid
required
string
tenant
required
string

Customer environment name

Responses

Response samples

Content type
application/json
{
  • "additionalInfo": [
    ],
  • "code": "string",
  • "message": "string"
}

Management - Event Consumption

Platform consumption is measured by events present in datasets this api allows user

Retrieves the event consumption data accesible by the current user.

Authorizations:
InverbisOauth2
path Parameters
tenant
required
string

Customer environment name

query Parameters
endDate
string <yyyy-mm-dd>

Final lookup date

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

The organization unique identifier (UID)

startDate
string <yyyy-mm-dd>

Initial lookup date

Responses

Response samples

Content type
application/json
{
  • "currentEventConsumption": 0,
  • "histogram": [
    ],
  • "maxAllowedEvents": -1
}

Retrieves the event consumption data accessible by the current user.

Authorizations:
InverbisOauth2
path Parameters
tenant
required
string

Customer environment name

query Parameters
endDate
string <yyyy-mm-dd>

Final lookup date

limit
integer <int32>

Page size for pagination

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

The organization unique identifier (UID)

start
integer <int32>

Page index for pagination

startDate
string <yyyy-mm-dd>

Initial lookup date

Responses

Response samples

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

Management - Environments

Provide access to environmental information.

Retrieves information about the user environment

Authorizations:
InverbisOauth2
path Parameters
tenant
required
string

Customer environment name

Responses

Response samples

Content type
application/json
{
  • "defaultMaxEvents": 0,
  • "defaultMaxUploadSize": 0,
  • "name": "string",
  • "public": true,
  • "subdomain": "string"
}

Ingest - File Upload

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}.

Authorizations:
InverbisOauth2
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.

Authorizations:
InverbisOauth2
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",
  • "<init>": "string"
}

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
path
string
absoluteFile
object (File) Recursive
absolutePath
string
canonicalFile
object (File) Recursive
canonicalPath
string
freeSpace
integer <int64>
name
string
parent
string
parentFile
object (File) Recursive
totalSpace
integer <int64>
usableSpace
integer <int64>
absolute
boolean
directory
boolean
file
boolean
hidden
boolean
invalid
boolean

Responses

Powerbi - Download

Download the .pbix file for Power Bi Desktop

Authorizations:
InverbisOauth2
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
{
  • "additionalInfo": [
    ],
  • "code": "string",
  • "message": "string"
}

Management - Datasets - Performance Booster

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
Authorizations:
InverbisOauth2
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
activities
Array of strings
attribute
string
limit
integer <int32>
sortBy
string
sortDirection
string
transitions
Array of strings
variants
Array of strings

Responses

Request samples

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

Response samples

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

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
Authorizations:
InverbisOauth2
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
content
string
limit
integer <int32>
sortBy
string
sortDirection
string

Responses

Request samples

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

Response samples

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

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

Authorizations:
InverbisOauth2
query Parameters
limit
integer <int32>

Page size for pagination

projectId
string
Example: projectId=X54Jasdw78

String corresponding to project identifier

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

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.

Authorizations:
InverbisOauth2
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:
Array of objects (ActivityDTO)
Array of objects (ArcDTO)
datasetUid
string
name
string [ 5 .. 100 ] characters
projectUid
string

Responses

Request samples

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

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.

Authorizations:
InverbisOauth2
path Parameters
modelId
required
string
Example: X54Jasdw78

String corresponding to model id

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

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.

Authorizations:
InverbisOauth2
path Parameters
modelId
required
string
Example: X54Jasdw78

String corresponding to model id

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 [ 5 .. 100 ] characters
<init>
required
string [ 5 .. 100 ] characters

Name of the new bpmn model

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "<init>": "string"
}

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.

Authorizations:
InverbisOauth2
path Parameters
modelId
required
string
Example: X54Jasdw78

String corresponding to model id

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

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
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
attributes
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

Array of objects or null

Represents a collections of filters

Responses

Request samples

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

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
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
attributes
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

Array of objects or null

Represents a collections of filters

object

Represents the json model to perform conformance against

Responses

Request samples

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

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
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

timeSplit
string

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

Responses

Request samples

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

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
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

object

Represents the json model to perform conformance against

timeSplit
string

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

Responses

Request samples

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

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
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
activityType
string

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

Array of objects or null

Represents a collections of filters

Responses

Request samples

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

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
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
activityType
string

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

Array of objects or null

Represents a collections of filters

object

Represents the json model to perform conformance against

Responses

Request samples

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

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
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

Responses

Request samples

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

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
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

object

Represents the json model to perform conformance against

Responses

Request samples

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

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.

Authorizations:
InverbisOauth2
path Parameters
datasetId
required
string
query Parameters
datasetId
string
Example: datasetId=X54Jasdw78

String corresponding to dataset identifier

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
limit
integer or null <int32>
sortBy
string
sortDirection
string
start
integer or null <int32>

Responses

Request samples

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

Response samples

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

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.

Authorizations:
InverbisOauth2
path Parameters
datasetId
required
string
traceId
required
string
query Parameters
datasetId
string
Example: datasetId=X54Jasdw78

String corresponding to dataset identifier

traceId
string
Example: traceId=X54Jasdw78

String corresponding to trace identifier

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
{
  • "data": [
    ],
  • "total": 0
}