logo
API docs by Redocly

Workflow Management REST Service (2.17)

Download OpenAPI specification:Download

The Workflow Management API provides developers a way to view and manage the status of the workflow system (Online/Offline), as well as view Reminders and Subscription Histories.

Extended Information

Resources related to extended information.

Extended Information

Create Extended Information tied to an Extended Information Calculation. This Extended Information will be asynchronously computed. If a callbackUrl is provided, the system will POST the following request body containing the computed values. [Rev 2.16]

{
  "extendedInformationItems": [
    {
      "key": "CustomerID",
      "value": "1234"
    }
  ]
}
Authorizations:
SWT
header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
callbackUrl
string

Provide a callbackUrl which will be notified when the extended information is computed.

required
Array of objects (ExtendedInformationItem)

A list of extended information items that will be computed asynchronously. The key is a unique identifier for the item, and the value will be computed based on the provided key.

Array of objects (ReferenceItem)

A list of reference items that will be used to compute the extended information. The key is a unique identifier for the item, and the value will be used as a replacement when the key is used as IDI smart data in extendedInformationItems. For example, the key CustomerID with a value of 1234 will replace @[CustomerID] in the value of an ExtendedInformationItem.

temporary
boolean

If true, the extended information will be temporary and will not be stored permanently in the system. This is useful for testing or transient calculations.

Responses

Request samples

Content type
application/json
{
  • "callbackUrl": "https://example.com/callback",
  • "extendedInformationItems": [
    ],
  • "referenceItems": [
    ],
  • "temporary": false
}

Response samples

Content type
application/json
{
  • "extendedInformationCalculationID": 1234,
  • "extendedInformationID": 1234
}

Import and Export

Resources related to importing and exporting objects from the system.

Export

Issues a request to export object(s) from the Workflow system. [Rev 1.33]

Authorizations:
SWT
query Parameters
workflowVersionID
required
integer
Example:

Unique identifier for the workflow version definition to export. If specified, the definitions property on the response will be populated.

header Parameters
Content-Type
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "definitions": [
    ],
  • "environment": "WORKFLOW_MAIN",
  • "exportUser": "KHAR",
  • "exportDate": "2018-10-26T14:01:09.731Z"
}

Import

Issues a request to import object(s) from the Workflow system. [Rev 1.33]

Authorizations:
SWT
header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
Array of objects (ImportDefinition)

A list of workflow definitions to import.

Responses

Request samples

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

Response samples

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

Processing Status

Resources related to processing status.

Query Processing Status

Query the current processing status, as well as the requested processing status (if any) of the Workflow system.

Permissions

Manage or View Companies is required to query or affect Workflow processing. This API is intended to be used by IDI internal systems and should not be called from customer code.

Authorizations:
SWT

Responses

Response samples

Content type
application/json
{
  • "currentStatus": "Online",
  • "requestedStatus": "Offline"
}

Start Processing

Requests that the Workflow system start processing.

Permissions

Manage or View Companies is required to query or affect Workflow processing. This API is intended to be used by IDI internal systems and should not be called from customer code.

Responses

Response samples

Content type
application/json
{
  • "currentStatus": "Online",
  • "requestedStatus": "Offline"
}

Stop Processing

Requests that the Workflow system stop processing.

Permissions

Manage or View Companies is required to query or affect Workflow processing. This API is intended to be used by IDI internal systems and should not be called from customer code.

Responses

Response samples

Content type
application/json
{
  • "currentStatus": "Online",
  • "requestedStatus": "Offline"
}

Reminder

Resources related to Reminders.

Search Reminders

An OData-like endpoint that returns a list of Reminders.

Available Fields

The following is a list of fields from the Message and how the can be used within the search.

  • Filterable: reminderID, reminderType, reminderTypeID, workflowInstance, workflowInstanceID, workItemInstance, workItemInstanceID, signalName
Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
number
Example: $skip=10

Number of search results to skip.

$skiptoken
number
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
number
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@odata.count": 145,
  • "@odata.nextLink": "https://api.idibilling.com/WorkflowManagement/2X/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
  • "value": [
    ]
}

Single Reminder

Retrieve a single Reminder record item.

Authorizations:
SWT
path Parameters
id
required
number
Example: 1

Identifier of the Reminder record.

header Parameters
Content-Type
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "remindAtDate": "2017-09-20T21:07:42.248Z",
  • "reminderID": 1,
  • "reminderType": "Auto-Complete",
  • "reminderTypeID": 1,
  • "workflowInstance": "My Workflow 2",
  • "workflowInstanceID": 1003,
  • "workItemInstance": "A Special Task",
  • "workItemInstanceID": 3323,
  • "signalName": "Test signal name"
}

Signal

Resources related to Signals.

Associate signal to WorkItemInstance

Creates a signal associated with WorkItemInstance [Rev 2.10]

Authorizations:
SWT
header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
workItemInstanceID
required
integer

ID of the workItemInstance that the new signal will be associated to.

signalName
required
string

Name of the new signal.

Responses

Request samples

Content type
application/json
{
  • "workItemInstanceID": 3323,
  • "signalName": "Signal Name"
}

Response samples

Content type
application/json
{
  • "reminderID": 1,
  • "workflowInstanceID": 1003,
  • "workItemInstanceID": 3323,
  • "signalName": "Signal Name"
}

Receive signal for a WorkflowInstance

Receives incoming signal that associated with WorkflowInstance [Rev 2.10]

Authorizations:
SWT
header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
workflowInstanceID
required
integer

ID of the workflowInstance associated to the received signal.

signalName
required
string

Name of the signal.

Responses

Request samples

Content type
application/json
{
  • "workflowInstanceID": 3323,
  • "signalName": "Signal Name"
}

Split Method

Resources related to Split Methods.

Search Split Methods

An OData-like endpoint that returns a list of Split Methods.

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
number
Example: $skip=10

Number of search results to skip.

$skiptoken
number
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
number
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@odata.count": 145,
  • "@odata.nextLink": "https://api.idibilling.com/WorkflowManagement/2X/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
  • "value": [
    ]
}

Single Split Method

Retrieve a single Split Method record.

Authorizations:
SWT
path Parameters
id
required
number
Example: 1

Identifier of the Split Method record.

header Parameters
Content-Type
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "clause": "Default Identity",
  • "clauseID": 1,
  • "dataSource": "Workflow Action",
  • "dataSourceID": 1,
  • "description": "Allows for splitting Workflows by Service Type",
  • "filterClause": "$filter=Environment eq '{ENVIRONMENT}'",
  • "name": "Split Workflow by Service Type",
  • "splitMethodCode": "SPLIT_BY_SVC_TYPE",
  • "splitMethodID": 1,
  • "workflowType": "Order",
  • "workflowTypeID": 1
}

Search Split Method Groupings

An OData-like endpoint that returns a list of Split Method Groupings for a Split Method.

Authorizations:
SWT
path Parameters
splitMethodId
required
number
Example: 1

Identifier of the Split Method.

query Parameters
$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
number
Example: $skip=10

Number of search results to skip.

$skiptoken
number
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
number
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@odata.count": 145,
  • "@odata.nextLink": "https://api.idibilling.com/WorkflowManagement/2X/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
  • "value": [
    ]
}

Single Split Method Grouping

Retrieve a single Split Method Grouping record.

Authorizations:
SWT
path Parameters
splitMethodId
required
number
Example: 1

Identifier of the Split Method.

id
required
number
Example: 1

Identifier of the Split Method Grouping record.

header Parameters
Content-Type
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "allowUserDefinedSplitMethodGroupings": true,
  • "dataSourceColumnName": "SvcTypeId",
  • "dataSourceDisplayColumnName": "Service Type ID",
  • "dataType": "Integer",
  • "dataTypeID": 1,
  • "description": "Creates a split group by Service Type",
  • "List": "Workflow Status",
  • "ListID": 1,
  • "Name": "Service Type",
  • "splitMethod": "Split Workflow by Service Type",
  • "splitMethodGroupingCode": "SVC_TYPE",
  • "splitMethodGroupingID": 1,
  • "splitMethodID": 1
}

Subscription History

Resources related Subscription History.

Search Subscription History

An OData-like endpoint that returns a list of Subscription History records.

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
number
Example: $skip=10

Number of search results to skip.

$skiptoken
number
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
number
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@odata.count": 145,
  • "@odata.nextLink": "https://api.idibilling.com/WorkflowManagement/2X/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
  • "value": [
    ]
}

Single Subscription History

Retrieve a single Subscription History item with the full event and result messages.

Authorizations:
SWT
path Parameters
id
required
number
Example: 1

Identifier of the subscription history record.

header Parameters
Content-Type
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "action": "Web API Action",
  • "actionID": 1,
  • "createDate": "2017-01-01T14:00:00.156Z",
  • "durationSeconds": 60,
  • "endDate": "2017-01-01T14:01:00.156Z",
  • "event": "Workflow Definition Modified",
  • "eventID": 1007,
  • "eventMessage": "",
  • "resultMessage": "",
  • "startDate": "2017-01-01T14:00:00.156Z",
  • "subscription": "My Subscription",
  • "subscriptionHistoryID": 47,
  • "subscriptionID": 89,
  • "subscriptionResult": "Completed Successfully",
  • "subscriptionResultID": 1,
  • "workflowActionLogFilename": "TestSubscription_2017-01-01T14-00-00.0000000-05-00.log"
}

Download Subscription History Log File

Provides the ability to download a log file associated to a SubscriptionHistory. [Rev 2.15]

Permissions

Manage or View Companies is required to download subscription history log files. This API is intended to be used by IDI internal systems and should not be called from customer code.

Authorizations:
SWT
path Parameters
id
required
number
Example: 1

Identifier of the subscription history record.

Responses

Response samples

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

Delete Subscription History

Delete subscription history records from the system, in bulk.

Permissions

Manage or View Companies is required to delete subscription history when the environment in the request differs from the environment the user is authenticated in. This API is intended to be used by IDI internal systems and should not be called from customer code.

path Parameters
fromDate
required
string
Example: 2017-01-01T19:00:00.000Z

ISO8601 string for the date to delete subscription history from.

toDate
required
string
Example: 2017-01-15T19:00:00.000Z

ISO8601 string for the date to delete subscription history to.

environment
string
Example: COMPAY_P_PRODUCTION

Name of the environment to delete subscription history for.

header Parameters
Content-Type
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "countDeleted": 37,
  • "countRemaining": 1055,
  • "environment": "COMPANY_P_PRODUCTION",
  • "fromDate": "2017-01-01T14:00:00.156Z",
  • "toDate": "2017-01-15T14:00:00.156Z"
}

Run Recurring Subscription Now

Run a recurring subscription immediately. Subscription must be recurring and enabled.

Authorizations:
SWT
path Parameters
subscriptionID
required
number
Example: 1

Unique identifier of the subscription to run now.

header Parameters
Content-Type
required
string
Example: application/json

Responses

System Integrity

Resources related to System Integrity.

Health Check

Use to check whether or not the Workflow system is up and running.

Authorizations:
SWT

Responses

Work Item Instance

Resources related to Work Item Instances.

Activate Work Item Instance

Activates a work item instance, i.e., sets the work item instance's status to "In Progress". [Rev 1.44]

Authorizations:
SWT
path Parameters
workItemInstanceId
required
number
Example: 12345

Unique identifier of the work item instance to activate.

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
note
string

If specified, the note to be added to the work item instance.

Responses

Request samples

Content type
application/json
{
  • "note": "This is a note on a work item instance"
}

Response samples

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

Complete Work Item Instance

Completes a work item instance, i.e., sets the work item instance's status to "Completed". [Rev 1.44]

Authorizations:
SWT
path Parameters
workItemInstanceId
required
number
Example: 12345

Unique identifier of the work item instance to complete.

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
note
string

If specified, the note to be added to the work item instance.

Responses

Request samples

Content type
application/json
{
  • "note": "This is a note on a work item instance"
}

Response samples

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

Error Work Item Instance

Errors a work item instance, i.e., sets the work item instance's status to "In Error". [Rev 1.44]

Authorizations:
SWT
path Parameters
workItemInstanceId
required
number
Example: 12345

Unique identifier of the work item instance to error.

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
note
string

If specified, the note to be added to the work item instance.

Responses

Request samples

Content type
application/json
{
  • "note": "This is a note on a work item instance"
}

Response samples

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

Wait Work Item Instance

Waits a work item instance, i.e., sets the work item instance's status to "Waiting". [Rev 1.44]

Authorizations:
SWT
path Parameters
workItemInstanceId
required
number
Example: 12345

Unique identifier of the work item instance to wait.

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
note
string

If specified, the note to be added to the work item instance.

Responses

Request samples

Content type
application/json
{
  • "note": "This is a note on a work item instance"
}

Response samples

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

Download Work Item Instance History Log File

Provides the ability to download a log file associated to a WorkItemInstanceHistory. [Rev 2.15]

Permissions

Manage or View Companies is required to download work item instance history log files. This API is intended to be used by IDI internal systems and should not be called from customer code.

Authorizations:
SWT
path Parameters
workItemInstanceHistoryId
required
number
Example: 12345

Unique identifier of the work item instance history.

Responses

Response samples

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

Workflow Instance

Resources related to Workflow Instances.

Get Split Grouping Entries

Some subworkflows may have split grouping data associated with it that indicates which items the child workflow is processing on behalf of its parent. This API is an OData-like endpoint that retrieves the collection of split groupings associated to the given workflowInstanceId.

Available Fields

The following is a list of fields from the Message and how the can be used within the search.

  • Filterable: displayValue, splitMethodGroupingCode, value, workflowInstanceSplitGroupingId
  • Sortable: displayValue, splitMethodGroupingCode, value, workflowInstanceSplitGroupingId
Authorizations:
SWT
path Parameters
workflowInstanceId
required
number
Example: 12345

Unique identifier of the workflow instance to retrieve grouping information for.

query Parameters
$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
number
Example: $skip=10

Number of search results to skip.

$skiptoken
number
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
number
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@odata.count": 145,
  • "@odata.nextLink": "https://api.idibilling.com/WorkflowManagement/2X/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
  • "value": [
    ]
}

Get Signals

Gets the signals associated to the workflow instance. [Rev 2.10]

Available Fields

The following is a list of fields from the Message and how the can be used within the search.

  • Filterable: createDate, processDate, signalName, workflowInstanceSignalID
  • Sortable: createDate, processDate, signalName, workflowInstanceSignalID
Authorizations:
SWT
path Parameters
workflowInstanceId
required
number
Example: 12345

Unique identifier of the workflow instance to retrieve signals for.

query Parameters
$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
number
Example: $skip=10

Number of search results to skip.

$skiptoken
number
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
number
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@odata.count": 145,
  • "@odata.nextLink": "https://api.idibilling.com/WorkflowManagement/2X/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
  • "value": [
    ]
}

Release Notes

Release Notes 2.17

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 2.16

Release Notes 2.15

Release Notes 2.14

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 2.13

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 2.12

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 2.11

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 2.10

  • Added GET api/workflowInstance/{workflowInstanceId}/signal - Retrieve the signals associated to the workflow instance.
  • Added Receive Signals POST api/signal/receive - Receives incoming signal that associated with WorkflowInstance.
  • Added POST api/signal, used to create a signal that is associated to a WorkItemInstance.
  • Updated GET api/reminder/{id} .
    • Added signalName to the response
    • Updated remindAtDate to be optional
  • Updated GET api/reminder .
    • Added signalName to the response
    • Updated remindAtDate to be optional

Release Notes 2.09

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 2.08

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 2.07

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 2.06

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 2.05

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 2.04

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 2.03

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 2.02

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 2.01

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 2.00

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 1.50

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 1.49

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 1.48

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 1.47

Release Notes 1.46

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 1.45

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 1.44

Release Notes 1.43

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 1.42

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 1.41

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 1.40

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 1.39

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 1.38

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 1.37

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 1.36

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 1.35

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 1.34

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 1.33

  • Added GET api/export - Exports object(s) from the Workflow system.

  • Added GET api/import - Import object(s) to the Workflow system.

Release Notes 1.32

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 1.31

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 1.30

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 1.29

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 1.28

  • Added AllowUserDefinedSplitMethodGroupings to SplitMethodGrouping, a property that indicates if a split method grouping allows splitting based on user defined values.

Release Notes 1.27

  • Added GET api/splitmethod - An OData-like endpoint that returns a list of split methods.

  • Added GET api/splitmethod/{id} - Retrieves a single split method.

  • Added GET api/splitmethod/{splitMethodId}/grouping - An OData-like endpoint that returns a list of split method grouping records for a split method.

  • Added GET api/splitmethod/{splitMethodId}/grouping/{id} - Retrieves a single split method grouping record for a split method.

Release Notes 1.26

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 1.25

  • Added GET api/workflowInstance/{workflowInstanceId}/splitGrouping - Query the split grouping data associated to a particular workflow instance.

Release Notes 1.24

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 1.23

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 1.22

  • Added GET api/processingstatus - Query the current processing status.

  • Added POST api/processingstatus/start - Requests that the Workflow system start processing.

  • Added POST api/processingstatus/stop - Requests that the Workflow system stop processing.

Release Notes 1.21

  • Added GET api/reminder - An OData-like endpoint that returns a list of Reminder records.

  • Added GET api/reminder/{id} - Retrieve a single Reminder item.

Release Notes 1.20

  • Added GET api/subscription/history - An OData-like endpoint that returns a list of Subscription History records.

  • Added DELETE api/subscription/history - Delete subscription history records from the system.

  • Added GET api/subscription/history/{id} - Retrieve a single Subscription History item with the full event and result messages.