Skip to content
Docs
Select language:English

/api/v1/things/move/preview

POST
/api/v1/things/move/preview
curl --request POST \
  --url https://example.com/api/v1/things/move/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "thingIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "to": { "placeId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" } }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
thingIds
required
Array<string>
>= 1 items <= 200 items
to
required
Any of:
object
placeId
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)$/
Examplegenerated
{
  "thingIds": [
    "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
  ],
  "to": {
    "placeId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
  }
}

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
crossLocation
required
boolean
crossAccount
required
boolean
targetLocation
required
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
losesSight
required
Array<object>
object
displayName
required
string
copies
required
object
types
required
integer
>= -9007199254740991 <= 9007199254740991
tags
required
integer
>= -9007199254740991 <= 9007199254740991
people
required
integer
>= -9007199254740991 <= 9007199254740991
vendors
required
integer
>= -9007199254740991 <= 9007199254740991
brands
required
integer
>= -9007199254740991 <= 9007199254740991
purchases
required
integer
>= -9007199254740991 <= 9007199254740991
Examplegenerated
{
  "crossLocation": true,
  "crossAccount": true,
  "targetLocation": {
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "name": "example"
  },
  "losesSight": [
    {
      "displayName": "example"
    }
  ],
  "copies": {
    "types": 1,
    "tags": 1,
    "people": 1,
    "vendors": 1,
    "brands": 1,
    "purchases": 1
  }
}