Update core attributes configurations for a Container type.

1min

PUT
API to update core attributes configuration of a container type specified by containerTypeName.The configuration includes:
List of core attributes (names) - Data type of each core attribute.
Validation of core attribute values, if required, for each core attribute.
Important:
If the attribute is already defined for the container type- The validation rules will get updated for the attribute.
If the attribute is not defined for the container type- It is added as a new core attribute for the container type.
On successful execution of the API, all updates including change in data type will take effect immediately for the container type.
PARAMETERDESCRIPTIONTYPEVALIDATION
attributes*
ㅤ↳name*Name of the attribute to be updated.stringExample: capacityminLength: 3 maxLength: 64
ㅤ↳dataType*Field for the datatype of an attribute.stringExample: integerEnum: [string, number, boolean, object, array]
ㅤ↳descriptionUpdated description of the attribute.stringminLength: 1 maxLength: 256
ㅤ↳indexedField to specify if the attribute is to be indexed. Filter or search operation on the basis of a custom attribute will be only allowed if this field is set as TRUE.booleanDefault: false
defaultValue
ㅤ↳validationSpecifies all the validations to be performed on an attribute, when a container of this type is created/updated.
ㅤㅤㅤ↳rangeField to specify the range that the attribute value must lie. In case of "string" data type, range will be the length of string value.numbermin: The min value, inclusive.max: The max value, inclusive.
ㅤㅤㅤ↳regexField to specify the regex pattern that the value of an attribute MUST match.stringminLength: 1 maxLength: 512
ㅤㅤㅤ↳valueOneOfField to specify enum values for an attribute. list of valueOneOf should be homogeneous.EnumminItems: 1
ㅤㅤㅤ↳requiredField to specify if the value for the attribute is mandatory or not. If TRUE, the value MUST be provided.booleanDefault value: false
callbackRepresents callback URL, which can be to notify status(success/failed) of API.object{url: "string", meta: {}}
*This is required.
HTTP Status Code Summary
CodeDescription
202 - Accepted
400 - Bad RequestThe request was unacceptable, often due to missing a required parameter.
401 - UnauthorizedNo valid API key provided.
404 - Not FoundThe requested resource doesn't exist.
503 - Server ErrorSomething went wrong. (These are rare.)
Path Parameters
containerTypeName
string
*
Header Parameters
X-COREOS-REQUEST-ID
string
*
X-COREOS-TID
string
*
X-COREOS-ACCESS
string
*
X-COREOS-USERINFO
string
X-COREOS-CALLBACK-SECRET
string
X-COREOS-ORIGIN-TOKEN
string
*
Body Parameters
body
AttributesConfigUpdateRequest
*
Description
Update core attributes of particular type of container
attributes
AttributeConfig[]
*
Responses
202
Accepted
SuccessResponse
data
object
request
Request
400
Error Occurred
PutErrorResponse
error
Error
request
Request
401
Error Occurred
PutErrorResponse
error
Error
request
Request
404
Error Occurred
PutErrorResponse
error
Error
request
Request
503
Error Occurred
PutErrorResponse
error
Error
request
Request
Curl
JS
Ruby
Python
curl --location --globoff --request PUT 'https://{tenantSubdomain}.io/core/api/v2/containers/container-types/{containerTypeName}/config/attributes' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "attributes": [
    {
      "name": "",
      "dataType": ""
    }
  ]
}'
curl --location --globoff --request PUT 'https://{tenantSubdomain}.io/core/api/v2/containers/container-types/{containerTypeName}/config/attributes' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "attributes": [
    {
      "name": "",
      "dataType": ""
    }
  ]
}'
Responses
202
400
401
404
503
// Accepted 
{
  "data": {
    "id": ""
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  }
}
// Accepted 
{
  "data": {
    "id": ""
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  }
}
﻿
﻿

PARAMETER	DESCRIPTION	TYPE	VALIDATION
`attributes`*
ㅤ↳`name`*	Name of the attribute to be updated.	string	Example: capacityminLength: 3 maxLength: 64
ㅤ↳`dataType`*	Field for the datatype of an attribute.	string	Example: integerEnum: [string, number, boolean, object, array]
ㅤ↳`description`	Updated description of the attribute.	string	minLength: 1 maxLength: 256
ㅤ↳`indexed`	Field to specify if the attribute is to be indexed. Filter or search operation on the basis of a custom attribute will be only allowed if this field is set as TRUE.	boolean	Default: false
`defaultValue`
ㅤ↳`validation`	Specifies all the validations to be performed on an attribute, when a container of this type is created/updated.
ㅤㅤㅤ↳`range`	Field to specify the range that the attribute value must lie. In case of "string" data type, range will be the length of string value.	number	min: The min value, inclusive.max: The max value, inclusive.
ㅤㅤㅤ↳`regex`	Field to specify the regex pattern that the value of an attribute MUST match.	string	minLength: 1 maxLength: 512
ㅤㅤㅤ↳`valueOneOf`	Field to specify enum values for an attribute. list of valueOneOf should be homogeneous.	Enum	minItems: 1
ㅤㅤㅤ↳`required`	Field to specify if the value for the attribute is mandatory or not. If TRUE, the value MUST be provided.	boolean	Default value: false
`callback`	Represents callback URL, which can be to notify status(success/failed) of API.	object	{url: "string", meta: {}}
*This is required.

HTTP Status Code Summary

Code	Description
202 - Accepted
400 - Bad Request	The request was unacceptable, often due to missing a required parameter.
401 - Unauthorized	No valid API key provided.
404 - Not Found	The requested resource doesn't exist.
503 - Server Error	Something went wrong. (These are rare.)

Updated 24 Aug 2023

Did this page help you?

Get core attributes configurations of a container type

Get state machine configuration of container type