Update Site Profile (v2.0)
PUT/v2.0/api/tenants/:tenant_id/bulkconfigurations/sitetemplates/:site_template_id
Update a site profile.
Request
Path Parameters
The tenant ID.
The site template ID.
- application/json
Body
update of the Site Profile
Data
Id
Site Type: Required(error = SITE_ROLE_MISSING: Site role missing.) ValidateEnum(enumClass = classOf[ElementClusterRole], error = INVALID_SITE_TYPE: Invalid site type, nullAllowed = false)
Template Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: Description length exceeds limit, min = 0)
Template Name: Required(error = TEMPLATE_NAME_REQUIRED: Template name missing) Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of the resource exceeds limit., min = 0)
Responses
- 200
- 400
Successful Operation
- application/json
- Schema
- Example (from schema)
Schema
Data required to deploy new sites at scale using the site template.
The ID.
The site ID.
The site type. Branch or DC.
The site template description. Max length = 256.
The template ID.
The site template name. Max length = 128.
The tenant ID.
Data required to deploy new sites at scale using this template.
{
"data": "string",
"id": "string",
"site_id": "string",
"site_type": "string",
"template_description": "string",
"template_id": "string",
"template_name": "string",
"tenant_id": "string",
"variable_map": {}
}
Bad Request
- application/json
- Schema
- Example (from schema)
- Example
Schema
- Array [
- ]
_error ErrorResponse[]
The error code.
The error message.
{
"_error": [
{
"code": "string",
"message": "string"
}
]
}
{
"value": {
"_error": [
{
"code": "INVALID_JSON"
},
{
"code": "TEMPLATE_UPDATE_INVALID"
},
{
"code": "TEMPLATE_DEPLOYMENT_EXISTS"
},
{
"code": "INVALID_UPDATE_OPERATION"
},
{
"code": "TEMPLATE_INVALID_FORMAT"
},
{
"code": "TEMPLATE_VARIABLE_MISMATCH"
},
{
"code": "INVALID_VARIABLE_CHARACTER"
}
]
}
}