Protocol Messages

Overview

A ProtocolMessage is a message sent to a BPI including the payload and other parameters necessary for context resolution and execution of a Workstep which is part of a previously-deployed Workflow.

ProtocolMessage Schema

Field	Type	Description
id*	string	internal identifier of the associated record or object included as payload; this identifier is typically the primary key of a record
type*	string	unique identifier indicating the domain model of the associated record or object included as payload
payload*	object	arbitrary object, e.g. containing the fields specified by the domain model referenced by type, or binary data
workstep_id	uuid	identifier of the previously-deployed WorkstepInstance which is the desired target for execution; this parameter is optional, and when provided, modifies the behavior of Workstep context resolution

API Requests

Create a Protocol Message

Create Protocol Message

POST https://baseline.provide.services/api/v1/protocol_messages

Creates an outbound protocol message

Request Body

Name	Type	Description
id*	string	internal identifier of the associated record or object included as payload
type*	string	unique identifier indicating the domain model of the associated record or object included as payload
payload*	object	arbitrary object, e.g. containing the fields specified by the domain model referenced by type, or binary data
workstep_id	uuid	identifier of the previously-deployed WorkstepInstance which is the desired target for execution; this parameter is optional, and when provided, modifies the behavior of Workstep context resolution

202: Accepted

{
    // Response
}