Create Metadata

POST 
/api/v1/metadata/:namespace

Create Metadata

Request

Path Parameters

namespace stringrequired

Possible values: [questionnaire, higg]

The logical type of data that is set by Inspectorio

application/json

Body

items

object[]

required

Possible values: >= 1, <= 50

Metadata items

Array [

object

]

uid stringrequired

Possible values: non-empty and <= 100 characters

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.

Responses

201

Created

application/json

Schema

Schema

data

object

items

object[]

required

Possible values: >= 1, <= 50

Metadata items

Array [

oneOf

ValueTypeString

key stringrequired

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

The key

type stringrequired

Possible values: [string]

The type of the value

value stringrequired

The value

ValueTypeNumber

key stringrequired

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

The key

type stringrequired

Possible values: [number]

The type of the value

value numberrequired

The value

ValueTypeBoolean

key stringrequired

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

The key

type stringrequired

Possible values: [boolean]

The type of the value

value booleanrequired

The value

ValueTypeObject

key stringrequired

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

The key

type stringrequired

Possible values: [object]

The type of the value

value

object[]

required

Possible values: >= 1, <= 50

The value

Array [

oneOf

ValueTypeString

key stringrequired

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

The key

type stringrequired

Possible values: [string]

The type of the value

value stringrequired

The value

ValueTypeNumber

key stringrequired

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

The key

type stringrequired

Possible values: [number]

The type of the value

value numberrequired

The value

ValueTypeBoolean

key stringrequired

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

The key

type stringrequired

Possible values: [boolean]

The type of the value

value booleanrequired

The value

ValueTypeDate

key stringrequired

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

The key

type stringrequired

Possible values: [date]

The type of the value

value daterequired

The value

ValueTypeDateTime

key stringrequired

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

The key

type stringrequired

Possible values: [datetime]

The type of the value

value date-timerequired

The value

ValueTypeStringArray

key stringrequired

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

The key

type stringrequired

Possible values: [string-array]

The type of the value

value string[]required

Possible values: >= 1, <= 50

The value

ValueTypeNumberArray

key stringrequired

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

The key

type stringrequired

Possible values: [number-array]

The type of the value

value number[]required

Possible values: >= 1, <= 50

The value

ValueTypeDateArray

key stringrequired

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

The key

type stringrequired

Possible values: [date-array]

The type of the value

value date[]required

Possible values: >= 1, <= 50

The value

ValueTypeDateTimeArray

key stringrequired

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

The key

type stringrequired

Possible values: [datetime-array]

The type of the value

value date-time[]required

Possible values: >= 1, <= 50

The value

ValueTypeBooleanArray

key stringrequired

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

The key

type stringrequired

Possible values: [boolean-array]

The type of the value

value boolean[]required

Possible values: >= 1, <= 50

The value

]

ValueTypeDate

key stringrequired

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

The key

type stringrequired

Possible values: [date]

The type of the value

value daterequired

The value

ValueTypeDateTime

key stringrequired

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

The key

type stringrequired

Possible values: [datetime]

The type of the value

value date-timerequired

The value

ValueTypeStringArray

key stringrequired

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

The key

type stringrequired

Possible values: [string-array]

The type of the value

value string[]required

Possible values: >= 1, <= 50

The value

ValueTypeNumberArray

key stringrequired

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

The key

type stringrequired

Possible values: [number-array]

The type of the value

value number[]required

Possible values: >= 1, <= 50

The value

ValueTypeDateArray

key stringrequired

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

The key

type stringrequired

Possible values: [date-array]

The type of the value

value date[]required

Possible values: >= 1, <= 50

The value

ValueTypeDateTimeArray

key stringrequired

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

The key

type stringrequired

Possible values: [datetime-array]

The type of the value

value date-time[]required

Possible values: >= 1, <= 50

The value

ValueTypeBooleanArray

key stringrequired

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

The key

type stringrequired

Possible values: [boolean-array]

The type of the value

value boolean[]required

Possible values: >= 1, <= 50

The value

ValueTypeObjectArray

key stringrequired

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

The key

type stringrequired

Possible values: [object-array]

The type of the value

value array[]required

Possible values: >= 1, <= 50

The value

]

uid stringrequired

Possible values: non-empty and <= 100 characters

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.

Example (from schema)

{
  "data": {
    "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-09-26"
            ]
          },
          {
            "key": "test_key",
            "type": "datetime-array",
            "value": [
              "2024-09-26T07:09:45.205Z"
            ]
          },
          {
            "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-09-26"
        ]
      },
      {
        "key": "test_key",
        "type": "datetime-array",
        "value": [
          "2024-09-26T07:09:45.206Z"
        ]
      },
      {
        "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-09-26"
              ]
            },
            {
              "key": "test_key",
              "type": "datetime-array",
              "value": [
                "2024-09-26T07:09:45.206Z"
              ]
            },
            {
              "key": "test_key",
              "type": "boolean-array",
              "value": [
                true
              ]
            }
          ]
        ]
      }
    ],
    "uid": "374b5abc9dcb"
  }
}

400

Bad request

application/json

Schema

Schema

errorCode string
message string

Example (from schema)

{
  "errorCode": "Generic",
  "message": "Bad Request"
}

401

Unauthorized

application/json

Schema

Schema

errorCode string
message string

Example (from schema)

{
  "errorCode": "Generic",
  "message": "Cannot retrieve session data because of expired token"
}

422

Validation Error

application/json

Schema

Schema

errorCode string
errors object
message string

Example (from schema)

{
  "errorCode": "Generic",
  "errors": {
    "type": [
      "Input type is not valid"
    ]
  },
  "message": "Validation error"
}

500

Internal Error

application/json

Schema

Schema

errorCode string
errors object
message string

Example (from schema)

{
  "errorCode": "Generic",
  "errors": {
    "system": [
      "Internal error detail message"
    ]
  },
  "message": "Internal server error"
}

Loading...