Skip to content
Docs
Select language:English

/api/v1/type-fields/{id}/convert/preview

POST
/api/v1/type-fields/{id}/convert/preview
curl --request POST \
  --url https://example.com/api/v1/type-fields/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/convert/preview \
  --header 'Content-Type: application/json' \
  --data '{ "toSecret": true }'

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
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)$/

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
Any of:
object
toSecret
required
boolean

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
locations
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 | null
values
required
integer
>= -9007199254740991 <= 9007199254740991
convertible
required
integer
>= -9007199254740991 <= 9007199254740991
toNotes
required
integer
>= -9007199254740991 <= 9007199254740991
total
required
integer
>= -9007199254740991 <= 9007199254740991
Examplegenerated
{
  "locations": [
    {
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "name": "example",
      "values": 1,
      "convertible": 1,
      "toNotes": 1
    }
  ],
  "total": 1
}