Metadata

items object[]required

Metadata items

Possible values: >= 1, <= 50

Array [

type string

Type of the metadata item

Possible values: [boolean, boolean-array, date, date-array, datetime, datetime-array, number, number-array, object, object-array, string, string-array]

boolean

key stringrequired

The key

Possible values: non-empty and <= 100 characters, Value must match regular expression ^[a-zA-Z_]\w*$

Example: test_key

type stringrequired

The type of the value

Possible values: [boolean]

value booleanrequired

The value

Example: false

boolean-array

key stringrequired

The key

Possible values: non-empty and <= 100 characters, Value must match regular expression ^[a-zA-Z_]\w*$

Example: test_key

type stringrequired

The type of the value

Possible values: [boolean-array]

value boolean[]required

The value

Possible values: >= 1, <= 50

date

key stringrequired

The key

Possible values: non-empty and <= 100 characters, Value must match regular expression ^[a-zA-Z_]\w*$

Example: test_key

type stringrequired

The type of the value

Possible values: [date]

value daterequired

The value

Example: 2020-09-30

date-array

key stringrequired

The key

Possible values: non-empty and <= 100 characters, Value must match regular expression ^[a-zA-Z_]\w*$

Example: test_key

type stringrequired

The type of the value

Possible values: [date-array]

value date[]required

The value

Possible values: >= 1, <= 50

datetime

key stringrequired

The key

Possible values: non-empty and <= 100 characters, Value must match regular expression ^[a-zA-Z_]\w*$

Example: test_key

type stringrequired

The type of the value

Possible values: [datetime]

value date-timerequired

The value

Example: 2020-09-30T09:09:09Z

datetime-array

key stringrequired

The key

Possible values: non-empty and <= 100 characters, Value must match regular expression ^[a-zA-Z_]\w*$

Example: test_key

type stringrequired

The type of the value

Possible values: [datetime-array]

value date-time[]required

The value

Possible values: >= 1, <= 50

number

key stringrequired

The key

Possible values: non-empty and <= 100 characters, Value must match regular expression ^[a-zA-Z_]\w*$

Example: test_key

type stringrequired

The type of the value

Possible values: [number]

value numberrequired

The value

Example: 2021

number-array

key stringrequired

The key

Possible values: non-empty and <= 100 characters, Value must match regular expression ^[a-zA-Z_]\w*$

Example: test_key

type stringrequired

The type of the value

Possible values: [number-array]

value number[]required

The value

Possible values: >= 1, <= 50

object

key stringrequired

The key

Possible values: non-empty and <= 100 characters, Value must match regular expression ^[a-zA-Z_]\w*$

Example: test_key

type stringrequired

The type of the value

Possible values: [object]

value object[]required

The value

Possible values: >= 1, <= 50

Array [

type string

Type of the metadata item

Possible values: [boolean, boolean-array, date, date-array, datetime, datetime-array, number, number-array, string, string-array]

boolean

key stringrequired

The key

Possible values: non-empty and <= 100 characters, Value must match regular expression ^[a-zA-Z_]\w*$

Example: test_key

type stringrequired

The type of the value

Possible values: [boolean]

value booleanrequired

The value

Example: false

boolean-array

key stringrequired

The key

Possible values: non-empty and <= 100 characters, Value must match regular expression ^[a-zA-Z_]\w*$

Example: test_key

type stringrequired

The type of the value

Possible values: [boolean-array]

value boolean[]required

The value

Possible values: >= 1, <= 50

date

key stringrequired

The key

Possible values: non-empty and <= 100 characters, Value must match regular expression ^[a-zA-Z_]\w*$

Example: test_key

type stringrequired

The type of the value

Possible values: [date]

value daterequired

The value

Example: 2020-09-30

date-array

key stringrequired

The key

Possible values: non-empty and <= 100 characters, Value must match regular expression ^[a-zA-Z_]\w*$

Example: test_key

type stringrequired

The type of the value

Possible values: [date-array]

value date[]required

The value

Possible values: >= 1, <= 50

datetime

key stringrequired

The key

Possible values: non-empty and <= 100 characters, Value must match regular expression ^[a-zA-Z_]\w*$

Example: test_key

type stringrequired

The type of the value

Possible values: [datetime]

value date-timerequired

The value

Example: 2020-09-30T09:09:09Z

datetime-array

key stringrequired

The key

Possible values: non-empty and <= 100 characters, Value must match regular expression ^[a-zA-Z_]\w*$

Example: test_key

type stringrequired

The type of the value

Possible values: [datetime-array]

value date-time[]required

The value

Possible values: >= 1, <= 50

number

key stringrequired

The key

Possible values: non-empty and <= 100 characters, Value must match regular expression ^[a-zA-Z_]\w*$

Example: test_key

type stringrequired

The type of the value

Possible values: [number]

value numberrequired

The value

Example: 2021

number-array

key stringrequired

The key

Possible values: non-empty and <= 100 characters, Value must match regular expression ^[a-zA-Z_]\w*$

Example: test_key

type stringrequired

The type of the value

Possible values: [number-array]

value number[]required

The value

Possible values: >= 1, <= 50

string

key stringrequired

The key

Possible values: non-empty and <= 100 characters, Value must match regular expression ^[a-zA-Z_]\w*$

Example: test_key

type stringrequired

The type of the value

Possible values: [string]

value stringrequired

The value

Example: The value of test_key

string-array

key stringrequired

The key

Possible values: non-empty and <= 100 characters, Value must match regular expression ^[a-zA-Z_]\w*$

Example: test_key

type stringrequired

The type of the value

Possible values: [string-array]

value string[]required

The value

Possible values: >= 1, <= 50

]

object-array

key stringrequired

The key

Possible values: non-empty and <= 100 characters, Value must match regular expression ^[a-zA-Z_]\w*$

Example: test_key

type stringrequired

The type of the value

Possible values: [object-array]

value array[]required

The value

Possible values: >= 1, <= 50

string

key stringrequired

The key

Possible values: non-empty and <= 100 characters, Value must match regular expression ^[a-zA-Z_]\w*$

Example: test_key

type stringrequired

The type of the value

Possible values: [string]

value stringrequired

The value

Example: The value of test_key

string-array

key stringrequired

The key

Possible values: non-empty and <= 100 characters, Value must match regular expression ^[a-zA-Z_]\w*$

Example: test_key

type stringrequired

The type of the value

Possible values: [string-array]

value string[]required

The value

Possible values: >= 1, <= 50

]

uid stringrequired

Unique identifier of a Metadata. If the namespace is questionnaire, then the uid should be your organization id. If the namespace is higg, then the uid should be your higg id.

Possible values: non-empty and <= 100 characters

Example: 374b5abc9dcb

Metadata

{
  "items": [
    {
      "key": "test_key",
      "type": "string",
      "value": "The value of test_key"
    },
    {
      "key": "test_key",
      "type": "number",
      "value": 2021
    },
    {
      "key": "test_key",
      "type": "boolean",
      "value": false
    },
    {
      "key": "test_key",
      "type": "object",
      "value": [
        {
          "key": "test_key",
          "type": "string",
          "value": "The value of test_key"
        },
        {
          "key": "test_key",
          "type": "number",
          "value": 2021
        },
        {
          "key": "test_key",
          "type": "boolean",
          "value": false
        },
        {
          "key": "test_key",
          "type": "date",
          "value": "2020-09-30"
        },
        {
          "key": "test_key",
          "type": "datetime",
          "value": "2020-09-30T09:09:09Z"
        },
        {
          "key": "test_key",
          "type": "string-array",
          "value": [
            "string"
          ]
        },
        {
          "key": "test_key",
          "type": "number-array",
          "value": [
            0
          ]
        },
        {
          "key": "test_key",
          "type": "date-array",
          "value": [
            "2024-07-29"
          ]
        },
        {
          "key": "test_key",
          "type": "datetime-array",
          "value": [
            "2024-07-29T15:51:28.071Z"
          ]
        },
        {
          "key": "test_key",
          "type": "boolean-array",
          "value": [
            true
          ]
        }
      ]
    },
    {
      "key": "test_key",
      "type": "date",
      "value": "2020-09-30"
    },
    {
      "key": "test_key",
      "type": "datetime",
      "value": "2020-09-30T09:09:09Z"
    },
    {
      "key": "test_key",
      "type": "string-array",
      "value": [
        "string"
      ]
    },
    {
      "key": "test_key",
      "type": "number-array",
      "value": [
        0
      ]
    },
    {
      "key": "test_key",
      "type": "date-array",
      "value": [
        "2024-07-29"
      ]
    },
    {
      "key": "test_key",
      "type": "datetime-array",
      "value": [
        "2024-07-29T15:51:28.071Z"
      ]
    },
    {
      "key": "test_key",
      "type": "boolean-array",
      "value": [
        true
      ]
    },
    {
      "key": "test_key",
      "type": "object-array",
      "value": [
        [
          {
            "key": "test_key",
            "type": "string",
            "value": "The value of test_key"
          },
          {
            "key": "test_key",
            "type": "number",
            "value": 2021
          },
          {
            "key": "test_key",
            "type": "boolean",
            "value": false
          },
          {
            "key": "test_key",
            "type": "date",
            "value": "2020-09-30"
          },
          {
            "key": "test_key",
            "type": "datetime",
            "value": "2020-09-30T09:09:09Z"
          },
          {
            "key": "test_key",
            "type": "string-array",
            "value": [
              "string"
            ]
          },
          {
            "key": "test_key",
            "type": "number-array",
            "value": [
              0
            ]
          },
          {
            "key": "test_key",
            "type": "date-array",
            "value": [
              "2024-07-29"
            ]
          },
          {
            "key": "test_key",
            "type": "datetime-array",
            "value": [
              "2024-07-29T15:51:28.071Z"
            ]
          },
          {
            "key": "test_key",
            "type": "boolean-array",
            "value": [
              true
            ]
          }
        ]
      ]
    }
  ],
  "uid": "374b5abc9dcb"
}