Participant Service
Participant Type - State Machi...
Create events for a participant-type
1min
POST
HEADER PARAMETERS
X-COREOS-REQUEST-ID
string
*Unique requestId
X-COREOS-TID
string
*Tenant id
X-COREOS-ACCESS
string
*Unique core-os access token
X-COREOS-USERINFO
string
core-os user info
BODY PARAMETERS
body
EventCreateRequest
*Create new State Machine Event.
description
string
*Short description of the event. Max length 64 characters.
eventType
EventType
Specifies event is transitional or not
- TRANSITIONAL - Transitonal event is an event that upon invocation it will change the state of the participant.
- NON_TRANSITIONAL - Non_Transitonal event is an event that upon invocation it will not change the state of the participant.
- TRANSITIONAL - Transitonal event is an event that upon invocation it will change the state of the participant.
- NON_TRANSITIONAL - Non_Transitonal event is an event that upon invocation it will not change the state of the participant.
reasonCodes
string[]
Example: ["R-nnnn"]
List of valid reason codes that can raise this event code
participantTypeNames
string[]
List of valid participantTypeNames where this event can be applied
isEnabled
boolean
True - Event Code is valid & usable. False - Event Code is not usable
dataValidations
EventDataItem[]
Data expected along with the event and their respective validations, if any.
eventCode
string
Code of the event.
RESPONSES
201
OK - The request Succeeded.
SuccessResponseId
data
IdResponse
request
Request
400
Bad request - The server is unable to process the request due to something that is perceived to be a client error
ErrorResponse
error
Error
*Error Information
request
Request
*401
Unauthorized - The client's identity is unknown to the server. Verify that you are accessing the correct tenant and that your client ID and client secret are valid on that tenant.
ErrorResponse
error
Error
*Error Information
request
Request
*404
Not found - The server can not find the requested resource.
ErrorResponse
error
Error
*Error Information
request
Request
*

Updated 24 Aug 2023
Did this page help you?