Update Metadata
PUT/api/v1/metadata/:namespace/:uid
Update Metadata
Request​
Path Parameters
Possible values: [questionnaire
, higg
]
The logical type of data that is set by Inspectorio
UIDs (unique identifiers) are unique within Ecosystem + Namespace. You can consider it as a Unique Keys of ecosystem + namespace + uid
- application/json
Body
Array [
]
items
object[]
required
Possible values: >= 1
, <= 50
Metadata items
Responses​
- 200
- 400
- 401
- 422
- 500
OK
- application/json
- Schema
- Example (from schema)
Schema
Array [
- ValueTypeString
- ValueTypeNumber
- ValueTypeBoolean
- ValueTypeObject
- ValueTypeDate
- ValueTypeDateTime
- ValueTypeStringArray
- ValueTypeNumberArray
- ValueTypeDateArray
- ValueTypeDateTimeArray
- ValueTypeBooleanArray
- ValueTypeObjectArray
Array [
- ValueTypeString
- ValueTypeNumber
- ValueTypeBoolean
- ValueTypeDate
- ValueTypeDateTime
- ValueTypeStringArray
- ValueTypeNumberArray
- ValueTypeDateArray
- ValueTypeDateTimeArray
- ValueTypeBooleanArray
]
]
data
object
items
object[]
required
Possible values: >= 1
, <= 50
Metadata items
oneOf
Possible values: non-empty
and <= 100 characters
, Value must match regular expression ^[a-zA-Z_]\w*$
The key
Possible values: [string
]
The type of the value
The value
Possible values: non-empty
and <= 100 characters
, Value must match regular expression ^[a-zA-Z_]\w*$
The key
Possible values: [number
]
The type of the value
The value
Possible values: non-empty
and <= 100 characters
, Value must match regular expression ^[a-zA-Z_]\w*$
The key
Possible values: [boolean
]
The type of the value
The value
Possible values: non-empty
and <= 100 characters
, Value must match regular expression ^[a-zA-Z_]\w*$
The key
Possible values: [object
]
The type of the value
value
object[]
required
Possible values: >= 1
, <= 50
The value
oneOf
Possible values: non-empty
and <= 100 characters
, Value must match regular expression ^[a-zA-Z_]\w*$
The key
Possible values: [string
]
The type of the value
The value
Possible values: non-empty
and <= 100 characters
, Value must match regular expression ^[a-zA-Z_]\w*$
The key
Possible values: [number
]
The type of the value
The value
Possible values: non-empty
and <= 100 characters
, Value must match regular expression ^[a-zA-Z_]\w*$
The key
Possible values: [boolean
]
The type of the value
The value
Possible values: non-empty
and <= 100 characters
, Value must match regular expression ^[a-zA-Z_]\w*$
The key
Possible values: [date
]
The type of the value
The value
Possible values: non-empty
and <= 100 characters
, Value must match regular expression ^[a-zA-Z_]\w*$
The key
Possible values: [datetime
]
The type of the value
The value
Possible values: non-empty
and <= 100 characters
, Value must match regular expression ^[a-zA-Z_]\w*$
The key
Possible values: [string-array
]
The type of the value
Possible values: >= 1
, <= 50
The value
Possible values: non-empty
and <= 100 characters
, Value must match regular expression ^[a-zA-Z_]\w*$
The key
Possible values: [number-array
]
The type of the value
Possible values: >= 1
, <= 50
The value
Possible values: non-empty
and <= 100 characters
, Value must match regular expression ^[a-zA-Z_]\w*$
The key
Possible values: [date-array
]
The type of the value
Possible values: >= 1
, <= 50
The value
Possible values: non-empty
and <= 100 characters
, Value must match regular expression ^[a-zA-Z_]\w*$
The key
Possible values: [datetime-array
]
The type of the value
Possible values: >= 1
, <= 50
The value
Possible values: non-empty
and <= 100 characters
, Value must match regular expression ^[a-zA-Z_]\w*$
The key
Possible values: [boolean-array
]
The type of the value
Possible values: >= 1
, <= 50
The value
Possible values: non-empty
and <= 100 characters
, Value must match regular expression ^[a-zA-Z_]\w*$
The key
Possible values: [date
]
The type of the value
The value
Possible values: non-empty
and <= 100 characters
, Value must match regular expression ^[a-zA-Z_]\w*$
The key
Possible values: [datetime
]
The type of the value
The value
Possible values: non-empty
and <= 100 characters
, Value must match regular expression ^[a-zA-Z_]\w*$
The key
Possible values: [string-array
]
The type of the value
Possible values: >= 1
, <= 50
The value
Possible values: non-empty
and <= 100 characters
, Value must match regular expression ^[a-zA-Z_]\w*$
The key
Possible values: [number-array
]
The type of the value
Possible values: >= 1
, <= 50
The value
Possible values: non-empty
and <= 100 characters
, Value must match regular expression ^[a-zA-Z_]\w*$
The key
Possible values: [date-array
]
The type of the value
Possible values: >= 1
, <= 50
The value
Possible values: non-empty
and <= 100 characters
, Value must match regular expression ^[a-zA-Z_]\w*$
The key
Possible values: [datetime-array
]
The type of the value
Possible values: >= 1
, <= 50
The value
Possible values: non-empty
and <= 100 characters
, Value must match regular expression ^[a-zA-Z_]\w*$
The key
Possible values: [boolean-array
]
The type of the value
Possible values: >= 1
, <= 50
The value
Possible values: non-empty
and <= 100 characters
, Value must match regular expression ^[a-zA-Z_]\w*$
The key
Possible values: [object-array
]
The type of the value
Possible values: >= 1
, <= 50
The value
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.
{
"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.473Z"
]
},
{
"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.473Z"
]
},
{
"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.473Z"
]
},
{
"key": "test_key",
"type": "boolean-array",
"value": [
true
]
}
]
]
}
],
"uid": "374b5abc9dcb"
}
}
Bad request
- application/json
- Schema
- Example (from schema)
Schema
{
"errorCode": "Generic",
"message": "Bad Request"
}
Unauthorized
- application/json
- Schema
- Example (from schema)
Schema
{
"errorCode": "Generic",
"message": "Cannot retrieve session data because of expired token"
}
Validation Error
- application/json
- Schema
- Example (from schema)
Schema
{
"errorCode": "Generic",
"errors": {
"type": [
"Input type is not valid"
]
},
"message": "Validation error"
}
Internal Error
- application/json
- Schema
- Example (from schema)
Schema
{
"errorCode": "Generic",
"errors": {
"system": [
"Internal error detail message"
]
},
"message": "Internal server error"
}