Create a Site Profile (v2.0)

POST 
/v2.0/api/tenants/:tenant_id/bulkconfigurations/sitetemplates

Details of the site profile to be created using the jinja template and store in the database.

Request

Path Parameters

tenant_id stringrequired

The tenant ID.

application/json

Body

Details of the Site Profile to be created

data string

Data

id string

Id

site_id string

Site Id: Digits(fraction = 0, integer = 50, SITEID_INVALID)

site_type stringrequired

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 string

Template Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: Description length exceeds limit, min = 0)

template_name stringrequired

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)

variable_map object

Responses

200

Successful Operation

application/json

Schema

Schema

data string

Data required to deploy new sites at scale using the site template.

id string

The ID.

site_id string

The site ID.

site_type stringrequired

The site type. Branch or DC.

template_description string

The site template description. Max length = 256.

template_id string

The template ID.

template_name stringrequired

The site template name. Max length = 128.

tenant_id stringrequired

The tenant ID.

variable_map object

Data required to deploy new sites at scale using this template.

Example (from schema)

{
  "data": "string",
  "id": "string",
  "site_id": "string",
  "site_type": "string",
  "template_description": "string",
  "template_id": "string",
  "template_name": "string",
  "tenant_id": "string",
  "variable_map": {}
}

400

Bad Request

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
The error code.
message string
The error message.
]

Example (from schema)

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "value": {
    "_error": [
      {
        "code": "INVALID_JSON"
      },
      {
        "code": "SITE_NAME_REQUIRED"
      },
      {
        "code": "TEMPLATE_VARIABLE_MISMATCH"
      },
      {
        "code": "TEMPLATE_INVALID_FORMAT"
      },
      {
        "code": "VARIABLE_MAP_REQUIRED"
      },
      {
        "code": "TEMPLATE_REQUIRED"
      },
      {
        "code": "SITE_TYPE_REQUIRED"
      },
      {
        "code": "BOTH_SITEID_AND_DATA_SHOULD_NOT_BE_PRESENT"
      },
      {
        "code": "SITEID_OR_DATA_IS_MANDATORY"
      },
      {
        "code": "INVALID_SITEID"
      },
      {
        "code": "INVALID_SITE_TYPE"
      },
      {
        "code": "INVALID_VARIABLE_CHARACTER"
      },
      {
        "code": "TEMPLATE_CREATION_NOT_ALLOWED_ON_SHELL"
      },
      {
        "code": "DUPLICATE_RESOURCE"
      }
    ]
  }
}

Loading...