Download OpenAPI specification:
OperatorFabric API documentation
Get published cards matching the criteria given as parameters. Results are limited to the cards that the calling user is allowed to see (based on the card recipients). For performance reasons, the response does not contain all lightCard fields, the returned fields are : id, uid,publisher, processVersion,process, processInstanceId,state,title,summary,publishDate,startDate,endDate,severity, publisherType, representative,representativeType. The other fields are set to null.
| page | number Page number |
| size | number Page size (max number of items in page) |
| adminMode | boolean |
| includeChildCards | boolean |
| latestUpdateOnly | boolean |
Array of objects (FilterModel) | |
| selectedFields | Array of strings |
{- "page": 0,
- "size": 0,
- "adminMode": true,
- "includeChildCards": true,
- "latestUpdateOnly": true,
- "filters": [
- {
- "columnName": "string",
- "matchType": "EQUALS",
- "filter": [
- "string"
], - "operation": "AND"
}
], - "selectedFields": [
- "string"
]
}Get cards restricted to calling user. Cards all come with empty data and details. requesting this end point opens an SSE connection
| rangeStart | string <date-time> start of time range to get published card |
| rangeEnd | string <date-time> end of time range to get published card |
| notification | boolean Default: false If true, connection is kept for notification of new cards (not related to the specified range) |
| clientId | string A unique id to identify client to allow for reconnection (an autogenerated UUID is the best solution) |
[- {
- "type": "DELETE",
- "cardId": 12345
}
]Update existing subscription
| uiId required | string unique ui client id associated to subscription |
updated subscription
| rangeStart | object (EpochDate) Number of milliseconds since Epoch (long integer) |
| rangeEnd | object (EpochDate) Number of milliseconds since Epoch (long integer) |
{- "rangeStart": 1551868290379,
- "rangeEnd": 1551868290379
}{- "rangeStart": 1551868290379,
- "rangeEnd": 1551868290379
}Get archived cards matching the criteria given as parameters. Results are limited to the cards that the calling user is allowed to see (based on the card recipients). For performance reasons, the response does not contain all lightCard fields, the returned fields are : id, uid,publisher, processVersion,process, processInstanceId,state,title,summary,publishDate,startDate,endDate,severity, publisherType, representative,representativeType. The other fields are set to null.
| page | number Page number |
| size | number Page size (max number of items in page) |
| adminMode | boolean |
| includeChildCards | boolean |
| latestUpdateOnly | boolean |
Array of objects (FilterModel) | |
| selectedFields | Array of strings |
{- "page": 0,
- "size": 0,
- "adminMode": true,
- "includeChildCards": true,
- "latestUpdateOnly": true,
- "filters": [
- {
- "columnName": "string",
- "matchType": "EQUALS",
- "filter": [
- "string"
], - "operation": "AND"
}
], - "selectedFields": [
- "string"
]
}Publish one card to OperatorFabric
| publisher required | string Unique ID of the entity or service publishing the card |
| processVersion required | string Version of the associated process |
| process required | string ID of the associated process |
| processInstanceId required | string ID of the associated process instance |
| state required | string associated process state name |
| publishDate | object (EpochDate) Number of milliseconds since Epoch (long integer) |
| lttd | object (EpochDate) Number of milliseconds since Epoch (long integer) |
| startDate required | object (EpochDate) Number of milliseconds since Epoch (long integer) |
| endDate | object (EpochDate) Number of milliseconds since Epoch (long integer) |
| expirationDate | object (EpochDate) Number of milliseconds since Epoch (long integer) |
| severity required | string (SeverityEnum) Enum: "ALARM" "ACTION" "COMPLIANT" "INFORMATION" Severity of the card subject >
|
| tags | Array of strings Tags associated with the card |
object (RRule) An object representing the recurrence of the card (as defined in the RFC 5545) | |
Array of objects (TimeSpan) List of business time span associated to card | |
required | object (I18n) describes an i18n label |
required | object (I18n) describes an i18n label |
| titleTranslated | string Card title translated |
| summaryTranslated | string Card summary translated |
| userRecipients | Array of strings List of user recipients |
| groupRecipients | Array of strings List of group recipients |
| entitiesAllowedToRespond | Array of strings List of entities that can respond |
| entitiesRequiredToRespond | Array of strings List of entities that have to respond. It will be taken into account in addition to entitiesAllowedToRespond to determine if a user can send a response. If present and not empty, this list will be used for display in the card detail header instead of entitiesAllowedToRespond. |
| entityRecipients | Array of strings List of entity recipients |
| entityRecipientsForInformation | Array of strings List of entity recipients for information : Among entityRecipients which one are only for information. |
| entitiesAllowedToEdit | Array of strings List of entities that can edit the card |
| data | object Business data |
| hasBeenAcknowledged | boolean Is true if the card was acknowledged by current user |
| entitiesAcks | Array of strings List of entities that acknowledged the card |
| hasBeenRead | boolean Is true if the card was read by current user |
| publisherType | string (PublisherTypeEnum) Enum: "EXTERNAL" "ENTITY" Publisher type >
|
| representative | string Used in case of sending card as a representative of an entity or a publisher (unique ID of the entity or publisher) |
| representativeType | string (PublisherTypeEnum) Enum: "EXTERNAL" "ENTITY" Publisher type >
|
| wktGeometry | string Contains WKT geometry string ex. 'POINT (6.476709 52.569132)' |
| wktProjection | string Contains projection ex. 'EPSG:4326' |
| secondsBeforeTimeSpanForReminder | integer >= 0 |
| actions | Array of strings (CardActionEnum) Items Enum: "PROPAGATE_READ_ACK_TO_PARENT_CARD" "KEEP_CHILD_CARDS" "KEEP_EXISTING_ACKS_AND_READS" "KEEP_EXISTING_PUBLISH_DATE" "STORE_ONLY_IN_ARCHIVES" "NOT_NOTIFIED" |
{- "uid": 12345,
- "id": "cardIdFromMyProcess",
- "publisher": "MyService",
- "processVersion": "0.0.1",
- "process": "MyProcess",
- "processInstanceId": "MyProcess_001",
- "state": "started",
- "publishDate": 1546300800000,
- "lttd": 1546387230000,
- "startDate": 1546387200000,
- "endDate": 1546387250000,
- "expirationDate": 1546397250000,
- "severity": "ACTION",
- "tags": [
- "MyService",
- "MyProcess"
], - "title": {
- "key": "myservice.myprocess.title"
}, - "summary": {
- "key": "myservice.myprocess.title.summary"
}
}{- "id": "string",
- "uid": "string"
}Patch existing card
| id required | string card id |
card containing fields to be updated
| publisher required | string Unique ID of the entity or service publishing the card |
| processVersion required | string Version of the associated process |
| process required | string ID of the associated process |
| processInstanceId required | string ID of the associated process instance |
| state required | string associated process state name |
| publishDate | object (EpochDate) Number of milliseconds since Epoch (long integer) |
| lttd | object (EpochDate) Number of milliseconds since Epoch (long integer) |
| startDate required | object (EpochDate) Number of milliseconds since Epoch (long integer) |
| endDate | object (EpochDate) Number of milliseconds since Epoch (long integer) |
| expirationDate | object (EpochDate) Number of milliseconds since Epoch (long integer) |
| severity required | string (SeverityEnum) Enum: "ALARM" "ACTION" "COMPLIANT" "INFORMATION" Severity of the card subject >
|
| tags | Array of strings Tags associated with the card |
object (RRule) An object representing the recurrence of the card (as defined in the RFC 5545) | |
Array of objects (TimeSpan) List of business time span associated to card | |
required | object (I18n) describes an i18n label |
required | object (I18n) describes an i18n label |
| titleTranslated | string Card title translated |
| summaryTranslated | string Card summary translated |
| userRecipients | Array of strings List of user recipients |
| groupRecipients | Array of strings List of group recipients |
| entitiesAllowedToRespond | Array of strings List of entities that can respond |
| entitiesRequiredToRespond | Array of strings List of entities that have to respond. It will be taken into account in addition to entitiesAllowedToRespond to determine if a user can send a response. If present and not empty, this list will be used for display in the card detail header instead of entitiesAllowedToRespond. |
| entityRecipients | Array of strings List of entity recipients |
| entityRecipientsForInformation | Array of strings List of entity recipients for information : Among entityRecipients which one are only for information. |
| entitiesAllowedToEdit | Array of strings List of entities that can edit the card |
| data | object Business data |
| hasBeenAcknowledged | boolean Is true if the card was acknowledged by current user |
| entitiesAcks | Array of strings List of entities that acknowledged the card |
| hasBeenRead | boolean Is true if the card was read by current user |
| publisherType | string (PublisherTypeEnum) Enum: "EXTERNAL" "ENTITY" Publisher type >
|
| representative | string Used in case of sending card as a representative of an entity or a publisher (unique ID of the entity or publisher) |
| representativeType | string (PublisherTypeEnum) Enum: "EXTERNAL" "ENTITY" Publisher type >
|
| wktGeometry | string Contains WKT geometry string ex. 'POINT (6.476709 52.569132)' |
| wktProjection | string Contains projection ex. 'EPSG:4326' |
| secondsBeforeTimeSpanForReminder | integer >= 0 |
| actions | Array of strings (CardActionEnum) Items Enum: "PROPAGATE_READ_ACK_TO_PARENT_CARD" "KEEP_CHILD_CARDS" "KEEP_EXISTING_ACKS_AND_READS" "KEEP_EXISTING_PUBLISH_DATE" "STORE_ONLY_IN_ARCHIVES" "NOT_NOTIFIED" |
{- "uid": 12345,
- "id": "cardIdFromMyProcess",
- "publisher": "MyService",
- "processVersion": "0.0.1",
- "process": "MyProcess",
- "processInstanceId": "MyProcess_001",
- "state": "started",
- "publishDate": 1546300800000,
- "lttd": 1546387230000,
- "startDate": 1546387200000,
- "endDate": 1546387250000,
- "expirationDate": 1546397250000,
- "severity": "ACTION",
- "tags": [
- "MyService",
- "MyProcess"
], - "title": {
- "key": "myservice.myprocess.title"
}, - "summary": {
- "key": "myservice.myprocess.title.summary"
}
}{- "id": "string",
- "uid": "string"
}Get a list of all existing users, with pagination and filter options
[- {
- "login": "jcleese",
- "firstName": "John",
- "lastName": "Cleese",
- "groups": [
- "MONTY",
- "WANDA"
], - "entities": [
- "ENITY1",
- "ENTITY2"
]
}, - {
- "login": "gchapman",
- "firstName": "Graham",
- "lastName": "Chapman",
- "groups": [
- "MONTY"
], - "entities": [
- "ENITY1"
]
}
]Create a new user. If the user already exists, then an update of the user will be made. Be careful, login must be minimum 2 characters and must only contain lowercase letters, _, -, . or digits.
User to be created
| login required | string Login must be minimum 2 characters and must only contain lowercase letters, _, -, . or digits. |
| firstName | string |
| lastName | string |
string | |
| comment | string |
| groups | Array of strings[ items unique ] |
| entities | Array of strings[ items unique ] |
{- "login": "jcleese",
- "firstName": "John",
- "lastName": "Cleese",
- "groups": [
- "MONTY",
- "WANDA"
], - "entities": [
- "ENTITY1",
- "ENTITY2"
]
}{- "login": "jcleese",
- "firstName": "John",
- "lastName": "Cleese",
- "groups": [
- "MONTY",
- "WANDA"
], - "entities": [
- "ENTITY1",
- "ENTITY2"
]
}Update existing user
| login required | string user login (should match login in request body) |
User to be updated (login should match path parameter)
| login required | string Login must be minimum 2 characters and must only contain lowercase letters, _, -, . or digits. |
| firstName | string |
| lastName | string |
string | |
| comment | string |
| groups | Array of strings[ items unique ] |
| entities | Array of strings[ items unique ] |
{- "login": "jcleese",
- "firstName": "John",
- "lastName": "Cleese",
- "groups": [
- "MONTY",
- "WANDA"
], - "entities": [
- "ENTITY1",
- "ENTITY2"
]
}{- "login": "jcleese",
- "firstName": "John",
- "lastName": "Cleese",
- "groups": [
- "MONTY",
- "WANDA"
], - "entities": [
- "ENTITY1",
- "ENTITY2"
]
}Update existing user settings
| login required | string user login (should match login in request body) |
User settings to be updated (login should match path parameter)
| login required | string User login |
| locale | string User using browser format |
| playSoundForAlarm | boolean If this is set to true, a sound will be played for incoming cards with ALARM severity. |
| playSoundForAction | boolean If this is set to true, a sound will be played for incoming cards with ACTION severity. |
| playSoundForCompliant | boolean If this is set to true, a sound will be played for incoming cards with COMPLIANT severity. |
| playSoundForInformation | boolean If this is set to true, a sound will be played for incoming cards with INFORMATION severity. |
| systemNotificationAlarm | boolean If this is set to true, a notification will be sent for incoming cards with ALARM severity. |
| systemNotificationAction | boolean If this is set to true, a notification will be sent for incoming cards with ACTION severity. |
| systemNotificationCompliant | boolean If this is set to true, a notification will be sent for incoming cards with COMPLIANT severity. |
| systemNotificationInformation | boolean If this is set to true, a notification will be sent for incoming cards with INFORMATION severity. |
| playSoundOnExternalDevice | boolean If set to true and the user has an external device configured, sounds will be played on this device rather than in the browser |
| replayEnabled | boolean If this is set to true, sounds for incoming cards or reminders will be replayed until the user clicks anywhere on the screen. |
| replayInterval | integer Interval (in seconds) between sound replays. |
| hallwayMode | boolean If this is set to true, hallway mode for feed screen will be enabled |
| remoteLoggingEnabled | boolean If this is set to true, some of the ui logs are stored in the log file of cards-consultation service |
| showAcknowledgmentFooter | boolean If this is set to true, always show entities acknowledgments footer in card details |
| openNextCardOnAcknowledgment | boolean If this is set to true, in feed page, after card acknowledgment open next card in the feed |
object Filters on processes and states for user feed (exclusion filter) | |
object Indicates for which process states the user will be notified by email | |
| entitiesDisconnected | Array of strings Entities not represented by the user for his current session |
| sendCardsByEmail | boolean If this is set to true, Opfab will send unread cards notification by email |
| emailToPlainText | boolean If this is set to true, the emails' bodies will be plain text |
| sendDailyEmail | boolean If this is set to true, an email will be sent daily with all the cards received during the day |
| sendWeeklyEmail | boolean If this is set to true, an email will be sent weekly with all the cards received during the week |
string Email address to use as recipient for email notifications | |
| emailAttachmentTemplate | string Name of the handlebar template to use to build the email's attachement |
| emailAttachmentFileName | string Name of the attachement file in the email |
| timezoneForEmails | string Timezone used for emails sent by opfab |
{- "login": "jcleese",
- "locale": "en"
}{- "login": "jcleese",
- "locale": "en"
}Patch existing user settings
| login required | string user login |
User settings to be updated
| login required | string User login |
| locale | string User using browser format |
| playSoundForAlarm | boolean If this is set to true, a sound will be played for incoming cards with ALARM severity. |
| playSoundForAction | boolean If this is set to true, a sound will be played for incoming cards with ACTION severity. |
| playSoundForCompliant | boolean If this is set to true, a sound will be played for incoming cards with COMPLIANT severity. |
| playSoundForInformation | boolean If this is set to true, a sound will be played for incoming cards with INFORMATION severity. |
| systemNotificationAlarm | boolean If this is set to true, a notification will be sent for incoming cards with ALARM severity. |
| systemNotificationAction | boolean If this is set to true, a notification will be sent for incoming cards with ACTION severity. |
| systemNotificationCompliant | boolean If this is set to true, a notification will be sent for incoming cards with COMPLIANT severity. |
| systemNotificationInformation | boolean If this is set to true, a notification will be sent for incoming cards with INFORMATION severity. |
| playSoundOnExternalDevice | boolean If set to true and the user has an external device configured, sounds will be played on this device rather than in the browser |
| replayEnabled | boolean If this is set to true, sounds for incoming cards or reminders will be replayed until the user clicks anywhere on the screen. |
| replayInterval | integer Interval (in seconds) between sound replays. |
| hallwayMode | boolean If this is set to true, hallway mode for feed screen will be enabled |
| remoteLoggingEnabled | boolean If this is set to true, some of the ui logs are stored in the log file of cards-consultation service |
| showAcknowledgmentFooter | boolean If this is set to true, always show entities acknowledgments footer in card details |
| openNextCardOnAcknowledgment | boolean If this is set to true, in feed page, after card acknowledgment open next card in the feed |
object Filters on processes and states for user feed (exclusion filter) | |
object Indicates for which process states the user will be notified by email | |
| entitiesDisconnected | Array of strings Entities not represented by the user for his current session |
| sendCardsByEmail | boolean If this is set to true, Opfab will send unread cards notification by email |
| emailToPlainText | boolean If this is set to true, the emails' bodies will be plain text |
| sendDailyEmail | boolean If this is set to true, an email will be sent daily with all the cards received during the day |
| sendWeeklyEmail | boolean If this is set to true, an email will be sent weekly with all the cards received during the week |
string Email address to use as recipient for email notifications | |
| emailAttachmentTemplate | string Name of the handlebar template to use to build the email's attachement |
| emailAttachmentFileName | string Name of the attachement file in the email |
| timezoneForEmails | string Timezone used for emails sent by opfab |
{- "login": "jcleese",
- "locale": "en"
}{- "login": "jcleese",
- "locale": "en"
}Update list of group users, users not included in given list are removed from group
| id required | string Group id |
Array of user ids representing exactly the intended list of group users after update
[- "string"
]Update list of entity users, users not included in given list are removed from entity.
| id required | string Entity id |
Array of user logins representing exactly the intended list of entity users after update
[- "string"
]Get existing user's perimeters from their login.
| login required | string user login |
[- {
- "id": "Process1",
- "process": "Process1",
- "stateRights": [
- {
- "state": "State1",
- "right": "Receive"
}, - {
- "state": "State2",
- "rights": "ReceiveAndWrite"
}
]
}, - {
- "id": "Process2",
- "process": "Process2",
- "stateRights": [
- {
- "state": "State1",
- "right": "ReceiveAndWrite"
}, - {
- "state": "State2",
- "rights": "Write"
}
]
}
]Get information about the user connected and his perimeters.
{- "userData": {
- "login": "jcleese",
- "firstName": "John",
- "lastName": "Cleese",
- "groups": [
- "MONTY",
- "WANDA"
], - "entities": [
- "ENITY1",
- "ENTITY2"
]
}, - "computedPerimeters": [
- {
- "process": "Process1",
- "state": "State1",
- "rights": "Receive"
}, - {
- "process": "Process1",
- "state": "State2",
- "rights": "ReceiveAndWrite"
}
]
}Get information about a user and his perimeters.
| login required | string user login |
{- "userData": {
- "login": "jcleese",
- "firstName": "John",
- "lastName": "Cleese",
- "groups": [
- "MONTY",
- "WANDA"
], - "entities": [
- "ENITY1",
- "ENTITY2"
]
}, - "computedPerimeters": [
- {
- "process": "Process1",
- "state": "State1",
- "rights": "Receive"
}, - {
- "process": "Process1",
- "state": "State2",
- "rights": "ReceiveAndWrite"
}
]
}Get the list the user actions.
| login | Array of strings usernames of the users who performed the actions |
| action | Array of strings types of actions performed |
| dateFrom | number Date as number of milliseconds since epoch. If this query parameter is set, only cards with a publishDate that is after this date will be returned. This parameter should be unique or a BAD REQUEST will be returned. |
| dateTo | number Date as number of milliseconds since epoch. If this query parameter is set, only cards with a publishDate that is before this date will be returned. This parameter should be unique or a BAD REQUEST will be returned. |
| page | number Page number of the page to retrieve. If "size" is set but "page" isn't, the default page returned will be the first (number 0). If "page" is set but "size" isn't, the default size will be 10 items. If neither "page" nor "size" is set, the response will contain a single page containing all matching cards. This parameter should be unique or a BAD REQUEST will be returned. |
| size | number Size of the results pages. If "size" is set but "page" isn't, the default page returned will be the first (number 0). If "page" is set but "size" isn't, the default size will be 10 items. If neither "page" nor "size" is set, the response will contain a single page containing all matching cards. This parameter should be unique or a BAD REQUEST will be returned. |
{- "content": [
- {
- "login": "string",
- "entities": [
- "string"
], - "action": "string",
- "cardUid": "string",
- "comment": "string"
}
], - "first": true,
- "last": true,
- "totalPages": 0,
- "totalElements": 0,
- "numberOfElements": 0,
- "size": 0,
- "number": 0
}Get a list of all existing groups, with pagination and filter options
[- {
- "id": "WANDA",
- "name": "Wanda",
- "description": "They were not as successful in Fierce Creatures"
}, - {
- "id": "MARXB",
- "name": "Marx Brothers",
- "description": "Chico, Groucho and Harpo, forget about Zeppo and Gummo"
}
]Create a new group of users
Group to be created
| id required | string Id must be minimum 2 characters and must only contain letters, _, - or digits. |
| name | string |
| description | string |
| users | Array of strings[ items unique ] |
| perimeters | Array of strings[ items unique ] |
| permissions | Array of strings (PermissionEnum) Items Enum: "ADMIN" "ADMIN_BUSINESS_PROCESS" "VIEW_ALL_CARDS" "VIEW_ALL_CARDS_FOR_USER_PERIMETERS" "VIEW_USER_ACTION_LOGS" "READONLY" |
{- "id": "WANDA",
- "name": "Wanda",
- "description": "They were not as successful in Fierce Creatures."
}{- "id": "WANDA",
- "name": "Wanda",
- "description": "They were not as successful in Fierce Creatures."
}Update existing group
| id required | string Id of group to be updated (should match "id group" in request body) |
Updated group data (should match "id group" path parameter)
| id required | string Id must be minimum 2 characters and must only contain letters, _, - or digits. |
| name | string |
| description | string |
| users | Array of strings[ items unique ] |
| perimeters | Array of strings[ items unique ] |
| permissions | Array of strings (PermissionEnum) Items Enum: "ADMIN" "ADMIN_BUSINESS_PROCESS" "VIEW_ALL_CARDS" "VIEW_ALL_CARDS_FOR_USER_PERIMETERS" "VIEW_USER_ACTION_LOGS" "READONLY" |
{- "id": "WANDA",
- "name": "Wanda",
- "description": "They were not as successful in Fierce Creatures."
}{- "id": "WANDA",
- "name": "Wanda",
- "description": "They were not as successful in Fierce Creatures."
}Update list of group users, users not included in given list are removed from group
| id required | string Group id |
Array of user ids representing exactly the intended list of group users after update
[- "string"
]Update list of groups that have this perimeter, groups not included in given list lose this perimeter.
| id required | string Perimeter id |
Array of group id representing exactly the intended list of groups that must have this perimeter after update
[- "string"
]Get existing group's perimeters from their id.
| id required | string group id |
[- {
- "id": "Process1",
- "process": "Process1",
- "stateRights": [
- {
- "state": "State1",
- "right": "Receive"
}, - {
- "state": "State2",
- "rights": "ReceiveAndWrite"
}
]
}, - {
- "id": "Process2",
- "process": "Process2",
- "stateRights": [
- {
- "state": "State1",
- "right": "ReceiveAndWrite"
}, - {
- "state": "State2",
- "rights": "Write"
}
]
}
]Update list of perimeters for group, perimeters not included in given list are no longer linked to the group.
| id required | string Group id |
Array of perimeter id representing exactly the intended list of perimeters that must be linked to the group after update
[- "string"
]Fetch a list of all existing entities, with pagination and filter options.
[- {
- "id": "ENTITY1",
- "name": "Control Room 1",
- "description": "Control Room 1"
}, - {
- "id": "ENTITY2",
- "name": "Control Room 2",
- "description": "Control Room 2"
}
]Create a new entity of users.
Entity to be created
| id required | string Id must be minimum 2 characters and must only contain letters, _, - or digits. |
| name | string |
| description | string |
| labels | Array of strings |
| parents | Array of strings[ items unique ] |
| roles | Array of strings (RoleEnum) Items Enum: "ACTIVITY_AREA" "ACTIVITY_AREA_GROUP" "CARD_SENDER" "CARD_RECEIVER" |
{- "id": "ENTITY1",
- "name": "Control Room 1",
- "description": "Control Room 1"
}{- "id": "ENTITY1",
- "name": "Control Room 1",
- "description": "Control Room 1"
}Update existing entity.
| id required | string Id of entity to be updated (should match id in request body) |
Updated entity data (should match id path parameter)
| id required | string Id must be minimum 2 characters and must only contain letters, _, - or digits. |
| name | string |
| description | string |
| labels | Array of strings |
| parents | Array of strings[ items unique ] |
| roles | Array of strings (RoleEnum) Items Enum: "ACTIVITY_AREA" "ACTIVITY_AREA_GROUP" "CARD_SENDER" "CARD_RECEIVER" |
{- "id": "ENTITY1",
- "name": "Control Room 1",
- "description": "Control Room 1"
}{- "id": "ENTITY1",
- "name": "Control Room 1",
- "description": "Control Room 1"
}Update list of entity users, users not included in given list are removed from entity.
| id required | string Entity id |
Array of user logins representing exactly the intended list of entity users after update
[- "string"
][- {
- "id": "Process1",
- "process": "Process1",
- "stateRights": [
- {
- "state": "State1",
- "right": "Receive"
}, - {
- "state": "State2",
- "rights": "ReceiveAndWrite"
}
]
}, - {
- "id": "Process2",
- "process": "Process2",
- "stateRights": [
- {
- "state": "State1",
- "right": "ReceiveAndWrite"
}, - {
- "state": "State2",
- "rights": "Write"
}
]
}
]Create a new perimeter.
Perimeter to be created
| id required | string Id must be minimum 2 characters and must only contain letters, _, - or digits. |
| process | string |
Array of objects (StateRight) |
{- "id": "Process1Perimeter1",
- "process": "Process1",
- "stateRights": [
- {
- "state": "state1",
- "right": "Receive"
}, - {
- "state": "state2",
- "right": "ReceiveAndWrite"
}
]
}{- "id": "Process1Perimeter1",
- "process": "Process1",
- "stateRights": [
- {
- "state": "state1",
- "right": "Receive"
}, - {
- "state": "state2",
- "right": "ReceiveAndWrite"
}
]
}Update existing perimeter.
| id required | string Id of perimeter to be updated (should match id in request body) |
Updated perimeter data (should match id path parameter)
| id required | string Id must be minimum 2 characters and must only contain letters, _, - or digits. |
| process | string |
Array of objects (StateRight) |
{- "id": "Process1Perimeter1",
- "process": "Process1",
- "stateRights": [
- {
- "state": "state1",
- "right": "Receive"
}, - {
- "state": "state2",
- "right": "ReceiveAndWrite"
}
]
}{- "id": "Process1Perimeter1",
- "process": "Process1",
- "stateRights": [
- {
- "state": "state1",
- "right": "Receive"
}, - {
- "state": "state2",
- "right": "ReceiveAndWrite"
}
]
}Fetch an existing perimeter.
| id required | string Perimeter id |
{- "id": "Process1Perimeter1",
- "process": "Process1",
- "stateRights": [
- {
- "state": "state1",
- "right": "Receive"
}, - {
- "state": "state2",
- "right": "ReceiveAndWrite"
}
]
}Update list of groups that have this perimeter, groups not included in given list lose this perimeter.
| id required | string Perimeter id |
Array of group id representing exactly the intended list of groups that must have this perimeter after update
[- "string"
]Get existing group's perimeters from their id.
| id required | string group id |
[- {
- "id": "Process1",
- "process": "Process1",
- "stateRights": [
- {
- "state": "State1",
- "right": "Receive"
}, - {
- "state": "State2",
- "rights": "ReceiveAndWrite"
}
]
}, - {
- "id": "Process2",
- "process": "Process2",
- "stateRights": [
- {
- "state": "State1",
- "right": "ReceiveAndWrite"
}, - {
- "state": "State2",
- "rights": "Write"
}
]
}
]Update list of perimeters for group, perimeters not included in given list are no longer linked to the group.
| id required | string Group id |
Array of perimeter id representing exactly the intended list of perimeters that must be linked to the group after update
[- "string"
]Get existing user's perimeters from their login.
| login required | string user login |
[- {
- "id": "Process1",
- "process": "Process1",
- "stateRights": [
- {
- "state": "State1",
- "right": "Receive"
}, - {
- "state": "State2",
- "rights": "ReceiveAndWrite"
}
]
}, - {
- "id": "Process2",
- "process": "Process2",
- "stateRights": [
- {
- "state": "State1",
- "right": "ReceiveAndWrite"
}, - {
- "state": "State2",
- "rights": "Write"
}
]
}
]Get existing processes. If the query parameter allVersions is absent or set to false, only the latest version of the processes will be returned.
| allVersions | boolean If true, all versions of processes will be returned. |
[- {
- "id": "some_business_process",
- "name": "some_business_process.label",
- "version": "v1.0",
- "initial_state": {
- "templateName": "template1"
}, - "other_state": {
- "templateName": "template2",
- "styles": [
- "my-template.css"
]
}
}
]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
| file required | string <binary> file to upload |
{- "id": "some_business_process",
- "name": "some_business_process.label",
- "version": "v1.0",
- "initial_state": {
- "templateName": "template1"
}, - "other_state": {
- "templateName": "template2",
- "styles": [
- "my-template.css"
]
}
}Get configuration data for a given process
| processId required | string Id of the process to retrieve |
| version | string Expected version of process (defaults to latest) |
{- "id": "some_business_process",
- "name": "some_business_process.label",
- "version": "v1.0",
- "initial_state": {
- "templateName": "template1"
}, - "other_state": {
- "templateName": "template2",
- "styles": [
- "my-template.css"
]
}
}Get all versions of configuration data for a given process
| processId required | string Id of the process to retrieve |
[- {
- "id": "some_business_process",
- "name": "some_business_process.label",
- "version": "v1.0",
- "initial_state": {
- "templateName": "template1"
}, - "other_state": {
- "templateName": "template2",
- "styles": [
- "my-template.css"
]
}
}
]Get template, if file exists return file (application/handlebars) otherwise return error message (application/json)
| processId required | string Id of the process to retrieve |
| templateName required | string Name of template to retrieve (w.o. extension) |
| version | string Expected version of template (defaults to latest) |
"string"Get css file, if file exists return file (text/css) otherwise return error message (application/json)
| processId required | string Id of the process to retrieve |
| cssFileName required | string Name of stylesheet file to retrieve (w.o. extension) |
| version | string Expected version of stylesheet (defaults to latest) |
"string"Get i18n file, if file exists return file (text/plain) otherwise return error message (application/json)
| processId required | string Id of the process to retrieve |
| version | string Expected version of i18n (defaults to latest) |
"string"Get response associated with a given state of a given process, returns a response (application/json)
| processId required | string Id of the process to retrieve |
| state required | string Name of state |
| version | string Required version of process (defaults to latest) |
{- "lock": true,
- "state": "string",
- "externalRecipients": [
- "string"
], - "emittingEntityAllowedToRespond": true,
- "showConfirmationPopup": true
}{- "fields": [
- {
- "field": "string",
- "type": null,
- "colName": "string",
- "size": 0,
- "defaultVisibility": true,
- "possibleValues": [
- "string"
]
}
], - "fieldsForProcesses": [
- {
- "process": "string",
- "fields": [
- {
- "field": "string",
- "type": null,
- "colName": "string",
- "size": 0,
- "defaultVisibility": true,
- "possibleValues": [
- "string"
]
}
]
}
], - "filters": {
- "tags": [
- {
- "label": "string",
- "value": "string"
}
], - "pageSize": 0
}
}Post the json defining the process monitoring config This json is saved to disk, under the name 'processmonitoring.json'. The uploaded file should be a valid JSON file containing the ProcessMonitoring object structure as defined in the schema
| file required | string <binary> file to upload |
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'.
| file required | string <binary> file to upload |