Skip to content
Select language:English

/api/v1/things/{id}/adjust

POST
/api/v1/things/{id}/adjust
curl --request POST \
--url https://example.com/api/v1/things/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/adjust \
--header 'Content-Type: application/json' \
--data '{ "delta": 1 }'
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
Media typeapplication/json
Any of:
object
delta
required
number
multiple of 0.001
Examplegenerated
{
"delta": 1
}

Default Response

Media typeapplication/json
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
locationId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
shortCode
required
string | null
name
required
string | null
type
required
Any of:
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
icon
required
string
name
required
string | null
builtinKey
required
string | null
quantity
required
number
lifecycle
required
string
derivedState
required
Array<string>
Allowed values: uncertain draft ended lent borrowed in_repair
path
required
Array<object>
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
name
required
string
kind
required
string
Allowed values: place container
isUnplaced
required
boolean
shortCode
string | null
containerThumbUrl
required
string | null
thumbUrl
required
string | null
lastSeenAt
required
string | null
isContainer
required
boolean
Example
{
"derivedState": [
"uncertain"
],
"path": [
{
"kind": "place"
}
]
}