Get reasons for a participant type.

1min

GET
https://{tenantSubdomain}/core/api/v2/participants/config/state-machine/reasons/{reasonCode}
This API is for get reasons based on given details.
Path Parameters
reasonCode
string
*
Header Parameters
X-COREOS-REQUEST-ID
string
*
X-COREOS-TID
string
*
X-COREOS-ACCESS
string
*
X-COREOS-USERINFO
string
Responses
200
OK - The request succeeded
ReasonsSuccessResponse
All Of
ErrorResponse  +
error
Error
*
request
Request
*
data
object
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
*
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
*
request
Request
*
503
Server error - The server is not ready to handle the request. This could be due to maintenance downtime or system resource constraints.
ErrorResponse
error
Error
*
request
Request
*
Curl
JS
Ruby
Python
curl --location --globoff 'https://{tenantSubdomain}/core/api/v2/participants/config/state-machine/reasons/{reasonCode}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
curl --location --globoff 'https://{tenantSubdomain}/core/api/v2/participants/config/state-machine/reasons/{reasonCode}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
Responses
200
400
401
503
// OK - The request succeeded 
{
  "error": {
    "code": "",
    "description": "",
    "additionalInfo": {}
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  },
  "data": {
    "description": "",
    "isEnabled": false,
    "reasonCode": ""
  }
}
// OK - The request succeeded 
{
  "error": {
    "code": "",
    "description": "",
    "additionalInfo": {}
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  },
  "data": {
    "description": "",
    "isEnabled": false,
    "reasonCode": ""
  }
}
﻿
﻿

Updated 31 May 2024

Did this page help you?

Update reasons for a participant type.

API to get list of orphan reasons codes (not associated with any reason code).