Update container type basic deatils

1min

PUT
API to update basic configuration of a container type specified by ContainerTypeName. Important: Core Attributes Configuration and State Machine Configuration of the container type cannot be updated using this API.
PARAMETERDESCRIPTIONTYPEVALIDATION
allowedParent*Rules defining the allowed/disallowed container types (singular name) as parent of a container type.
ㅤ↳oneOfList of container types allowed as parent of this container type.stringminItems: 1 maxItems: 16minLength: 3 maxLength: 64
ㅤ↳notList of container types not allowed as parent of this container type.stringminItems: 1 maxItems: 16minLength: 3 maxLength: 64
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
Body Parameters
body
ContainerTypeUpdateRequest
*
Description
Update Container type configuration
allowedParent
ContainerTypeAllowedParent
*
callback
object
Responses
202
Accepted
SuccessResponse
data
object
request
Request
400
Bad Request
ErrorResponse
error
Error
request
Request
401
Unauthorized
ErrorResponse
error
Error
request
Request
404
Not Found
ErrorResponse
error
Error
request
Request
503
Server Error
ErrorResponse
error
Error
request
Request
Curl
JS
Ruby
Python
curl --location --globoff --request PUT 'https://{tenantSubdomain}.io/core/api/v2/containers/container-types/{containerTypeName}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "allowedParent": {}
}'
curl --location --globoff --request PUT 'https://{tenantSubdomain}.io/core/api/v2/containers/container-types/{containerTypeName}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "allowedParent": {}
}'
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
`allowedParent`*	Rules defining the allowed/disallowed container types (singular name) as parent of a container type.
ㅤ↳`oneOf`	List of container types allowed as parent of this container type.	string	minItems: 1 maxItems: 16minLength: 3 maxLength: 64
ㅤ↳`not`	List of container types not allowed as parent of this container type.	string	minItems: 1 maxItems: 16minLength: 3 maxLength: 64
`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 container type deatils by containerTypeName