Relation - vPlan

Relations provide contact information to orders.

With the relation endpoint you can create and maintain a relation table in your vPlan’s database. However, they are not directly useable or visible in vPlan. You can use and refer to relation when creating or updating orders. That’s where they become visible as an object within the orders.

Relation

string <uuid>

read-onlyoptional

Unique identifier

name

string

optional

<= 100 characters

description

string | null

optional

<= 150 characters

type

string | null

optional

<= 255 characters

note

string | null

optional

<= 65535 characters

phone

string | null

optional

<= 25 characters

fax

string | null

optional

<= 25 characters

string <email> | null

optional

<= 254 characters

website

string <uri> | null

optional

<= 512 characters

external_ref

string | null

read-onlyoptional

Third-party reference of the object, for informational purposes only

Example:

fb1033a2ed70

created_at

string <date-time>

read-onlyoptional

Date and time of creation

Example:

2024-04-11T10:22:15Z

updated_at

string <date-time>

read-onlyoptional

Date and time of last update

Example:

2024-04-11T10:22:15Z