Blueriq REST API

The REST API for Blueriq Runtime.
More information: https://my.blueriq.com/display/DOC/REST+API
Contact info: support@blueriq.com
Version: 1.0

Access

Access to the API requires client-id and client secret.

Methods

Returns the Runtime information.

Parameters

Return type

Runtime

Example data

Content-Type: application/json

{
  "name" : "aeiou",
  "links" : "",
  "productionMode" : true,
  "version" : "aeiou"
}

Returns a paged list of case events.

Parameters

caseId (optional)
  Query Parameter — Id of the case. default:
page (optional)
  Query Parameter — The page number. default:
pageSize (optional)
  Query Parameter — The items per page. default:
sort (optional)
  Query Parameter — The properties to sort on (comma separated). default:

Return type

PagedCaseEvents

Example data

Content-Type: application/json

{
  "items" : "",
  "page" : 123,
  "itemsTotalCount" : 123,
  "pageSize" : 123,
  "links" : "",
  "nrOfPages" : 123
}

Returns the case event with the specified id.

Parameters

eventId (required)
  Path Parameter — The id of the event.

Return type

CaseEvent

Example data

Content-Type: application/json

{
  "id" : 123456789,
  "timestamp" : "2015-07-17T09:54:45.160+0000",
  "content" : "{}",
  "caseId" : 123456789,
  "status" : "aeiou",
  "name" : "aeiou",
  "links" : "",
  "type" : "aeiou",
  "user" : "aeiou"
}

Re-triggers the case event with the specified id. The original event is not changed, instead a new case event is created based on the original event. Using the caseId parameter it is possible to trigger an event only in a specific case (applicable when the original event was a broadcast event.

Parameters

eventId (required)
  Path Parameter — The id of the event.
caseId (optional)
  Query Parameter — The id of the case. default:

Return type

String

Example data

Content-Type: application/json

"aeiou"

Returns a paged list of cases available in the Runtime.

Parameters

page (optional)
  Query Parameter — The page number. default:
pageSize (optional)
  Query Parameter — The items per page. default:
sort (optional)
  Query Parameter — The properties to sort on (comma separated). default:
attributes (optional)
  Query Parameter — The case attributes to include (comma separated). default:

Return type

PagedCases

Example data

Content-Type: application/json

{
  "items" : "",
  "page" : 123,
  "itemsTotalCount" : 123,
  "pageSize" : 123,
  "links" : "",
  "nrOfPages" : 123
}

Returns the case with the specified id.

Parameters

caseId (required)
  Path Parameter — The id of the case.
attributes (optional)
  Query Parameter — The case attributes to include (comma separated). default:

Return type

Case

Example data

Content-Type: application/json

{
  "id" : 123456789,
  "creationDate" : "2015-07-17T09:54:45.171+0000",
  "lockedBy" : "aeiou",
  "status" : "aeiou",
  "name" : "aeiou",
  "applicationId" : "aeiou",
  "links" : "",
  "attributes" : "{}"
}

Returns the attributes of the case with the specified id.

Parameters

caseId (required)
  Path Parameter — The id of the case.

Return type

Object

Example data

Content-Type: application/json

"{}"

Returns the configured endpoints for webservices as a paged list.

Parameters

page (optional)
  Query Parameter — The page number. default:
pageSize (optional)
  Query Parameter — The items per page. default:
sort (optional)
  Query Parameter — The properties to sort on (comma separated). default:

Return type

PagedEndpoints

Example data

Content-Type: application/json

{
  "items" : "",
  "page" : 123,
  "itemsTotalCount" : 123,
  "pageSize" : 123,
  "links" : "",
  "nrOfPages" : 123
}

Returns the endpoint with the specified name.

Parameters

name (required)
  Path Parameter — The name of the endpoint.

Return type

Endpoint

Example data

Content-Type: application/json

{
  "name" : "aeiou",
  "links" : "",
  "url" : "aeiou"
}

Returns a paged list of the available projects.

Parameters

page (optional)
  Query Parameter — The page number. default:
pageSize (optional)
  Query Parameter — The items per page. default:
sort (optional)
  Query Parameter — The properties to sort on (comma separated). default:

Return type

PagedProjects

Example data

Content-Type: application/json

{
  "items" : "",
  "page" : 123,
  "itemsTotalCount" : 123,
  "pageSize" : 123,
  "links" : "",
  "nrOfPages" : 123
}

Returns the project with the specified id.

Parameters

id (required)
  Path Parameter — The id of the project.

Return type

Project

Example data

Content-Type: application/json

{
  "id" : "aeiou",
  "name" : "aeiou",
  "links" : "",
  "version" : "aeiou"
}

Returns the metadata of the project with the specified id.

Parameters

id (required)
  Path Parameter — The id of the project.

Return type

Metadata

Example data

Content-Type: application/json

{
  "libraries" : "",
  "webservicecalls" : "",
  "links" : ""
}

Returns a paged list of shortcuts.

Parameters

page (optional)
  Query Parameter — The page number. default:
pageSize (optional)
  Query Parameter — The number of items per page. default:
sort (optional)
  Query Parameter — The properties to sort on (comma separated). default:

Return type

PagedShortcuts

Example data

Content-Type: application/json

{
  "items" : "",
  "page" : 123,
  "itemsTotalCount" : 123,
  "pageSize" : 123,
  "links" : "",
  "nrOfPages" : 123
}

View the shortcut with the specified name.

Parameters

name (required)
  Path Parameter — The shortcut name.

Return type

Shortcut

Example data

Content-Type: application/json

{
  "ui" : "aeiou",
  "project" : "aeiou",
  "languageCode" : "aeiou",
  "theme" : "aeiou",
  "name" : "aeiou",
  "links" : "",
  "flow" : "aeiou",
  "channel" : "aeiou",
  "version" : "aeiou"
}

Returns a paged list of available tasks.

Parameters

page (optional)
  Query Parameter — The page number. default:
pageSize (optional)
  Query Parameter — The items per page. default:
sort (optional)
  Query Parameter — The properties to sort on (comma separated). default:
attributes (optional)
  Query Parameter — The case attributes to include (comma separated). default:
customFields (optional)
  Query Parameter — The custom fields to include (comma separated). default:

Return type

PagedTasks

Example data

Content-Type: application/json

{
  "items" : "",
  "page" : 123,
  "itemsTotalCount" : 123,
  "pageSize" : 123,
  "links" : "",
  "nrOfPages" : 123
}

Returns the task with the specified id.

Parameters

taskId (required)
  Path Parameter — The id of the task.
attributes (optional)
  Query Parameter — The case attributes to included (comma separated). default:
customFields (optional)
  Query Parameter — The custom fields to include (comma separated). default:

Return type

Task

Example data

Content-Type: application/json

{
  "startDate" : "2015-07-17T09:54:45.190+0000",
  "customFields" : "{}",
  "status" : "aeiou",
  "timeOutDate" : "2015-07-17T09:54:45.190+0000",
  "assignee" : {
    "teams" : "",
    "users" : "",
    "roles" : ""
  },
  "links" : "",
  "type" : "aeiou",
  "id" : 123456789,
  "executedBy" : "aeiou",
  "caseId" : 123456789,
  "priority" : 123,
  "name" : "aeiou",
  "conditional" : true,
  "eventName" : "aeiou",
  "attributes" : "{}",
  "lastPriorityCheck" : "2015-07-17T09:54:45.190+0000",
  "required" : true,
  "dueDate" : "2015-07-17T09:54:45.190+0000"
}

Updates the task with the specified id. Currently it is only possible to change the status property from started to open.

Parameters

taskId (required)
  Path Parameter — The id of the task.
body (optional)
  Body Parameter — The task object.

Return type

Task

Example data

Content-Type: application/json

{
  "startDate" : "2015-07-17T09:54:45.192+0000",
  "customFields" : "{}",
  "status" : "aeiou",
  "timeOutDate" : "2015-07-17T09:54:45.192+0000",
  "assignee" : {
    "teams" : "",
    "users" : "",
    "roles" : ""
  },
  "links" : "",
  "type" : "aeiou",
  "id" : 123456789,
  "executedBy" : "aeiou",
  "caseId" : 123456789,
  "priority" : 123,
  "name" : "aeiou",
  "conditional" : true,
  "eventName" : "aeiou",
  "attributes" : "{}",
  "lastPriorityCheck" : "2015-07-17T09:54:45.192+0000",
  "required" : true,
  "dueDate" : "2015-07-17T09:54:45.192+0000"
}

Models

PagedProjects

PropertyDatatypeDescription
page IntegerThe page number.
pageSize IntegerThe number of items in the page.
items ListThe paged collection.
nrOfPages Integer
itemsTotalCount Integer
links List

PagedTasks

PropertyDatatypeDescription
page IntegerThe page number.
pageSize IntegerThe number of items in the page.
items ListThe paged collection.
nrOfPages Integer
itemsTotalCount Integer
links List

PagedShortcuts

PropertyDatatypeDescription
page IntegerThe page number.
pageSize IntegerThe number of items in the page.
items ListThe paged collection.
nrOfPages Integer
itemsTotalCount Integer
links List

Runtime

PropertyDatatypeDescription
name StringThe name of the environment
version StringThe version of the Runtime
productionMode BooleanWhether the Runtime runs in production mode or not
links List

Void

PropertyDatatypeDescription

PagedCaseEvents

PropertyDatatypeDescription
page IntegerThe page number.
pageSize IntegerThe number of items in the page.
items ListThe paged collection.
nrOfPages Integer
itemsTotalCount Integer
links List

Assignee

PropertyDatatypeDescription
roles ArrayThe list of roles
users ArrayThe list of users
teams ArrayThe list of teams

PagedEndpoints

PropertyDatatypeDescription
page IntegerThe page number.
pageSize IntegerThe number of items in the page.
items ListThe paged collection.
nrOfPages Integer
itemsTotalCount Integer
links List

CaseEvent

PropertyDatatypeDescription
name StringThe case event name.
type StringThe case event type.
content ObjectThe content of the case event. Key value pair of parameters.
timestamp DateThe creation time.
status StringThe case event status.
caseId LongThe id of the case.
user StringThe user or system that created the event.
id LongThe id of the message.
links List

PagedCases

PropertyDatatypeDescription
page IntegerThe page number.
pageSize IntegerThe number of items in the page.
items ListThe paged collection.
nrOfPages Integer
itemsTotalCount Integer
links List

Link

PropertyDatatypeDescription
href String
rel String
templated Boolean

IWebservice

PropertyDatatypeDescription
name String
type String
endpoint String

Task

PropertyDatatypeDescription
name StringThe name of the task
priority IntegerThe priority of the task
type StringThe type of the task
attributes ObjectThe case attributes that are specified via the request
status StringThe status of the task
required BooleanIs the task required or not
conditional BooleanIs the task conditional
caseId LongThe id of the case
startDate DateThe startdate of the task
dueDate DateThe duedate of the task
eventName StringThe eventname of the task
id LongThe id of the task
customFields ObjectThe customFields that are specified via the request
executedBy StringThe name of the one who executes the task
lastPriorityCheck DateThe lastPriorityCheck of the task
assignee AssigneeInformation about the assignee of the task
timeOutDate DateThe timeOutDate of the task
links List

Case

PropertyDatatypeDescription
name StringThe name of the case
attributes ObjectThe case attributes that are specified via the request
status StringThe status of the case
applicationId StringThe id of the application
id LongThe id of the case
creationDate DateThe creation date of the case
lockedBy StringThe name of the one who locks the case
links List

Project

PropertyDatatypeDescription
name StringThe name of the project.
version StringThe version of the project.
id StringThe id of the project.
links List

Metadata

PropertyDatatypeDescription
libraries ListThe used libraries in the project.
webservicecalls ListThe used webservice calls in the project.
links List

Endpoint

PropertyDatatypeDescription
name StringThe name of the endpoint.
url StringThe url of the endpoint.
links List

ILibrary

PropertyDatatypeDescription
name String
version String
releaseNotes String

Shortcut

PropertyDatatypeDescription
name StringThe name of the shortcut.
channel StringThe channel.
version StringThe version of the project the shortcut will start.
theme StringThe theme the shortcut will use to start the project.
project StringThe project the shortcut will start.
flow StringThe flow the shortcut will start.
languageCode StringThe language code the shortcut will use to start the project.
ui StringThe user interface the shortcut will use to start the project.
links List