BusinessConfig Management
 4.2.0-RC.RELEASE 
OAS 2.0

[ Base URL: localhost:2002 ]

IMPORTANT - The Try it Out button will generate curl requests for examples, but executing them through the UI will not work as authentication has not been set up. This page is for documentation only.

Send email to the developer
Mozilla Public License V2.0

default

List existing processes. If the query parameter allVersions is absent or set to false, only the latest version of the processes will be returned.

Parameters

NameDescription
allVersions
boolean
(query)

If true, all versions of processes will be returned.

Responses

CodeDescription
200

OK

[
  {
    "id": "some_business_process",
    "name": "some_business_process.label",
    "version": "v1.0",
    "initial_state": {
      "templateName": "template1"
    },
    "other_state": {
      "templateName": "template2",
      "styles": [
        "my-template.css"
      ]
    }
  }
]
401

Authentication required

Upload process configuration bundle. Bundle is a gzipped tarball (tar.gz) containing a config.json file (containing a Process object in json notation) and the associated resource files

Parameters

NameDescription
file *
file
(formData)

file to upload

Responses

CodeDescription
201

Successful creation

{
  "id": "some_business_process",
  "name": "some_business_process.label",
  "version": "v1.0",
  "initial_state": {
    "templateName": "template1"
  },
  "other_state": {
    "templateName": "template2",
    "styles": [
      "my-template.css"
    ]
  }
}
401

Authentication required

403

Forbidden - ADMIN role necessary

Delete all existing process configuration data

Parameters

No parameters

Responses

CodeDescription
204

OK

401

Authentication required

500

Unable to delete processes

Access configuration data for a given process

Parameters

NameDescription
processId *
string
(path)

Id of the process to retrieve

version
string
(query)

Expected version of process (defaults to latest)

Responses

CodeDescription
200

OK

{
  "id": "some_business_process",
  "name": "some_business_process.label",
  "version": "v1.0",
  "initial_state": {
    "templateName": "template1"
  },
  "other_state": {
    "templateName": "template2",
    "styles": [
      "my-template.css"
    ]
  }
}
401

Authentication required

Delete existing process configuration data

Parameters

NameDescription
processId *
string
(path)

Id of the process to delete

Responses

CodeDescription
204

OK

401

Authentication required

404

Not found

500

Unable to delete process

Access all versions of configuration data for a given process

Parameters

NameDescription
processId *
string
(path)

Id of the process to retrieve

Responses

CodeDescription
200

OK

[
  {
    "id": "some_business_process",
    "name": "some_business_process.label",
    "version": "v1.0",
    "initial_state": {
      "templateName": "template1"
    },
    "other_state": {
      "templateName": "template2",
      "styles": [
        "my-template.css"
      ]
    }
  }
]
401

Authentication required

404

Not found

Get template, if file exists return file (application/handlebars) otherwise return error message (application/json)

Parameters

NameDescription
processId *
string
(path)

Id of the process to retrieve

templateName *
string
(path)

Name of template to retrieve (w.o. extension)

version
string
(query)

Expected version of template (defaults to latest)

Responses

CodeDescription
200

OK

"string"
401

Authentication required

404

No such template

Get css file, if file exists return file (text/css) otherwise return error message (application/json)

Parameters

NameDescription
processId *
string
(path)

Id of the process to retrieve

cssFileName *
string
(path)

Name of stylesheet file to retrieve (w.o. extension)

version
string
(query)

Expected version of stylesheet (defaults to latest)

Responses

CodeDescription
200

OK

"string"
404

No such template

Get i18n file, if file exists return file (text/plain) otherwise return error message (application/json)

Parameters

NameDescription
processId *
string
(path)

Id of the process to retrieve

version
string
(query)

Expected version of i18n (defaults to latest)

Responses

CodeDescription
200

OK

"string"
401

Authentication required

404

No such template

Get response associated with a given state of a given process, returns a response (application/json)

Parameters

NameDescription
processId *
string
(path)

Id of the process to retrieve

state *
string
(path)

Name of state

version
string
(query)

Required version of process (defaults to latest)

Responses

CodeDescription
200

OK

{
  "lock": true,
  "state": "string",
  "externalRecipients": [
    "string"
  ],
  "emittingEntityAllowedToRespond": true
}
401

Authentication required

404

No such process/state

Delete specific version of the configuration data for a given process

Parameters

NameDescription
processId *
string
(path)

Id of the process to delete

version *
string
(path)

Version of process to delete

Responses

CodeDescription
204

OK

401

Authentication required

404

Not found

500

Unable to delete version of process

Get the groups of processes

Parameters

No parameters

Responses

CodeDescription
200

OK

{
  "groups": [
    {
      "id": "processgroup1",
      "processes": [
        "id_process1",
        "id_process2"
      ]
    }
  ]
}
401

Authentication required

Upload file defining the groups of processes. This file must be in json format and is saved to disk, under the name 'processGroups.json'.

Parameters

NameDescription
file *
file
(formData)

file to upload

Responses

CodeDescription
201

Successful creation

401

Authentication required

403

Forbidden - ADMIN role necessary

Get the configuration for the real time screen

Parameters

No parameters

Responses

CodeDescription
200

OK

{
  "realTimeScreens": [
    {
      "screenName": "string",
      "onlyDisplayUsersInGroups": [
        "string"
      ],
      "screenColumns": [
        {
          "entitiesGroups": [
            "string"
          ]
        }
      ]
    }
  ]
}
401

Authentication required

Upload file defining the configuration for the real time screen. This file must be in json format and is saved to disk, under the name 'realtimescreens.json'.

Parameters

NameDescription
file *
file
(formData)

file to upload

Responses

CodeDescription
201

Successful creation

401

Authentication required

403

Forbidden - ADMIN role necessary

Get the list of the available business data

Parameters

No parameters

Responses

CodeDescription
200

OK

{}

Delete every resource

Parameters

No parameters

Responses

CodeDescription
200

OK

401

Authentication required

403

Forbidden - ADMIN role necessary

Get the business data

Parameters

NameDescription
resourceName *
string
(path)

Name of the resource

Responses

CodeDescription
200

OK

{}

Upload file containing businessdata This file must be in json format and is saved to disk.

Parameters

NameDescription
file *
file
(formData)

file to upload

resourceName *
string
(path)

Name of the resource

Responses

CodeDescription
201

Successful creation

401

Authentication required

403

Forbidden - ADMIN role necessary

Delete existing resource

Parameters

NameDescription
resourceName *
string
(path)

Name of the resource

Responses

CodeDescription
204

OK

401

Authentication required

404

Not found

500

Unable to delete resource

Get the monitoring configuration

Parameters

No parameters

Responses

CodeDescription
200

OK

{
  "export": {
    "fields": [
      {
        "columnName": "string",
        "jsonField": "string",
        "type": "Unknown Type: MonitoringExportFieldTypeEnum",
        "fields": [
          "string"
        ]
      }
    ]
  }
}
401

Authentication required

Post the json defining the monitoring config This json is saved to disk, under the name 'monitoring.json'.

Parameters

NameDescription
monitoring
(body)
{
  "export": {
    "fields": [
      {
        "columnName": "string",
        "jsonField": "string",
        "type": "Unknown Type: MonitoringExportFieldTypeEnum",
        "fields": [
          "string"
        ]
      }
    ]
  }
}

Responses

CodeDescription
201

Successful creation

401

Authentication required

403

Forbidden - ADMIN role necessary