Participant Service
Participant Type - Custom Code...
register custom code configurations of a participant type
1min
POST
PATH PARAMETERS
participantTypePluralName
ParticipantTypePluralName
*A unique *plural name* i.e. a term that defines multiple participants of this participant type. This is used as collection name in resource URL for this participant type and as participant id prefix.
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
CustomCodeCreateRequest
*Create new custom code for participantType
url
string
*request URL for the custom call
requestHeader
object
*request headers object for custom call
method
Method
*HTTP method requested on the API endpoint
wait
boolean
*acceptableStatusCodes
number[]
raiseErrorOnStatusMismatch
boolean
methodName
string<create:onError | update:onError | apply_event:onError | create:onRequest | update:onRequest | apply_event:onRequest>
*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?