Get Classification

GET 
/sites/:siteId/classifications/:classificationId

Get Classification

Request

Path Parameters

siteId stringrequired

Site Identifier

classificationId stringrequired

Classification Identifier

Query Parameters

locale string

Site Locale (ISO 639 / ISO 3166)

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

classification

object

name string

Name of Classification

userId string

insertedDate string

Inserted Timestamp

attributes

object

compositeKeys

object[]

List of Composite Keys

Array [

attributeKeys string[]

]

required

object[]

List of Required Attributes

Array [

attributeKey string

minNumberOfValues number

The minimum number of attribute values

maxNumberOfValues number

The maximum number of attribute values

defaultValue string

Default value

defaultValues string[]

Default values

allowedValues string[]

Only valid string values

localizedAllowedValues

object

property name* string

]

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

localizedAllowedValues

object

property name* string

]

allowAdditionalAttributes boolean

Default value: true

Example (from schema)

{
  "classification": {
    "name": "string",
    "userId": "string",
    "insertedDate": "string",
    "attributes": {
      "compositeKeys": [
        {
          "attributeKeys": [
            "string"
          ]
        }
      ],
      "required": [
        {
          "attributeKey": "string",
          "minNumberOfValues": 0,
          "maxNumberOfValues": 0,
          "defaultValue": "string",
          "defaultValues": [
            "string"
          ],
          "allowedValues": [
            "string"
          ],
          "localizedAllowedValues": {}
        }
      ],
      "optional": [
        {
          "minNumberOfValues": 0,
          "maxNumberOfValues": 0,
          "attributeKey": "string",
          "allowedValues": [
            "string"
          ],
          "localizedAllowedValues": {}
        }
      ],
      "allowAdditionalAttributes": true
    }
  }
}

Loading...