Update custom attributes configurations for a participant type

1min
PUT
https://{tenantSubdomain}/core/api/v2/participants/participant-types/{participantTypePluralName}/config/attributes
API to update custom attributes configuration of a participant type specified by participantTypeId. 

The configuration includes: 
1. List of custom attributes (names) 
2. Data type of each custom attribute 
3. Validation of custom attribute values, if required, for each custom attribute.

 Important: 

➊ If the attribute is already defined for the participant type- The validation rules will get updated for the attribute.
➋ If the attribute is not defined for the participant type - it is added as a new custom attribute for the participant type. 
➌ On successful execution of the API, all updates
will take effect immediately for the
participant type.
Path Parameters
participantTypePluralName
ParticipantTypePluralName
*
Header Parameters
X-COREOS-REQUEST-ID
string
*
X-COREOS-TID
string
*
X-COREOS-ACCESS
string
*
X-COREOS-USERINFO
string
X-COREOS-ORIGIN-TOKEN
string
*
X-COREOS-CALLBACK-SECRET
string
Body Parameters
body
AttributesConfigUpdateRequest
*
Description
Update core attributes config
All Of
AttributesConfig  +
attributes
AttributeConfig[]
Responses
202
OK - The request Accepted.
SuccessResponse
data
NameResponse
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
*
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
*
404
Not found - The server can not find the requested resource.
ErrorResponse
error
Error
*
request
Request
*
Curl
JS
Ruby
Python
curl --location --globoff --request PUT 'https://{tenantSubdomain}/core/api/v2/participants/participant-types/{participantTypePluralName}/config/attributes' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "attributes": [
    {
      "name": "",
      "dataType": ""
    }
  ]
}'
curl --location --globoff --request PUT 'https://{tenantSubdomain}/core/api/v2/participants/participant-types/{participantTypePluralName}/config/attributes' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "attributes": [
    {
      "name": "",
      "dataType": ""
    }
  ]
}'
Responses
202
400
401
404
// OK - The request Accepted. 
{
  "data": {
    "name": "vehicles"
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  }
}
// OK - The request Accepted. 
{
  "data": {
    "name": "vehicles"
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  }
}
﻿
﻿
Updated 31 May 2024
Did this page help you?
Get custom attributes configurations of a participant type
Get state-machine configurtion of a participant type