Set Sites Schema

PUT 
/sites/:siteId/schema/document

Sets Sites schema

Request

Path Parameters

siteId stringrequired

Site Identifier

application/json

Body

required

name string

Name of schema

attributes

object

compositeKeys

object[]

List of Composite Keys

Array [

attributeKeys string[]

]

required

object[]

List of Required Attributes

Array [

minNumberOfValues number

The minimum number of attribute values

maxNumberOfValues number

The maximum number of attribute values

attributeKey string

defaultValue string

Default value

defaultValues string[]

Default values

allowedValues string[]

Only valid string values

]

optional

object[]

List of Optional Attribute

Array [

minNumberOfValues number

The minimum number of attribute values

maxNumberOfValues number

The maximum number of attribute values

attributeKey string

allowedValues string[]

Only valid string values

]

allowAdditionalAttributes boolean

Default value: true

Responses

200

200 OK

Response Headers

• Access-Control-Allow-Origin

  string

• Access-Control-Allow-Methods

  string

• Access-Control-Allow-Headers

  string

application/json

Schema

Schema

message string

Result message

Example (from schema)

{
  "message": "string"
}

400

400 OK

application/json

Schema

Schema

errors

object[]

List of errors

Array [

key string

Error Key

error string

Error Message

]

Example (from schema)

{
  "errors": [
    {
      "key": "string",
      "error": "string"
    }
  ]
}

Loading...