register custom code configurations

1min
POST
api for registering custom code config
Header Parameters
X-COREOS-REQUEST-ID
string
*
X-COREOS-TID
string
*
X-COREOS-ACCESS
string
*
X-COREOS-USERINFO
string
*
Body Parameters
body
CustomCodeCreateRequest
*
Description
Create new custom code for dispatch
url
string
*
requestHeader
object
*
method
Method
*
wait
boolean
*
acceptableStatusCodes
number[]
raiseErrorOnStatusMismatch
boolean
methodName
string<createDispatch:onRequest | updateDispatch:onRequest | updateDispatchStatus:onRequest | updateDispatchSubStatus:onRequest | addParticipant:onRequest | removeParticipant:onRequest | addParticipantBulk:onRequest | addJob:onRequest | removeJob:onRequest | removeMultipleJobs:onRequest | removeJobFromDispatch:onRequest | removeMultipleJobsFromDispatch:onRequest | addJobByRef:onRequest | changeStatusByRef:onRequest | changeSubStatusByRef:onRequest | addMultipleJobsByRef:onRequest | removeMultipleJobsByRef:onRequest | removeJobByRef:onRequest | addParticipantByRef:onRequest | addMultipleParticipantsByRef:onRequest | removeParticipantByRef:onRequest | updateCustomDataByRef:onRequest | patchCustomDataByRef:onRequest | addJobBulk:onRequest | createJob:onRequest | updateCustomData:onRequest | patchCustomData:onRequest | updateJobStatus:onRequest | updateJobSubStatus:onRequest | custodyIn:onRequest | custodyOut:onRequest | custodyInBatch:onRequest | custodyOutBatch:onRequest | createDispatch:onError | updateDispatch:onError | updateDispatchStatus:onError | updateDispatchSubStatus | addParticipant:onError | removeParticipant:onError | addParticipantBulk:onError | addJob:onError | removeJob:onError | removeMultipleJobs:onError | removeJobFromDispatch:onError | removeMultipleJobsFromDispatch:onError | addJobByRef:onError | changeStatusByRef:onError | changeSubStatusByRef:onError | addMultipleJobsByRef:onError | removeMultipleJobsByRef:onError | removeJobByRef:onError | addParticipantByRef:onError | addMultipleParticipantsByRef:onError | removeParticipantByRef:onError | updateCustomDataByRef:onError | patchCustomDataByRef:onError | addJobBulk:onError | createJob:onError | updateCustomData:onError | patchCustomData:onError | updateJobStatus:onError | updateJobSubStatus:onError | custodyIn:onError | custodyOut:onError | custodyInBatch:onError | custodyOutBatch:onError>
*
Responses
200
OK
SuccessResponse
error
Error
*
request
Request
*
data
object
400
Error Occurred
PostErrorResponse
error
Error
*
request
Request
*
401
Error Occurred
PostErrorResponse
error
Error
*
request
Request
*
404
Error Occurred
PostErrorResponse
error
Error
*
request
Request
*
Curl
JS
Ruby
Python
curl --location --globoff 'https://{domain}/core/api/v2/dispatch-service/custom-code/config/handlers' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "url": "",
  "requestHeader": {},
  "method": "",
  "wait": false,
  "methodName": ""
}'
curl --location --globoff 'https://{domain}/core/api/v2/dispatch-service/custom-code/config/handlers' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "url": "",
  "requestHeader": {},
  "method": "",
  "wait": false,
  "methodName": ""
}'
Responses
200
400
401
404
// OK 
{
  "error": {
    "code": "",
    "description": "",
    "additionalInfo": {}
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  },
  "data": {
    "id": ""
  }
}
// OK 
{
  "error": {
    "code": "",
    "description": "",
    "additionalInfo": {}
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  },
  "data": {
    "id": ""
  }
}
﻿
﻿
Updated 03 Aug 2023
Did this page help you?
Apply CustodyOut Scan
update custom code configurations