Interface CustomObjectDraft

interface CustomObjectDraft {
    container: string;
    key: string;
    value: any;
    version?: number;
}

Properties

container key value version?

Properties

Readonly container

container: string

Namespace to group CustomObjects.

Readonly key

key: string

User-defined unique identifier of the CustomObject within the defined container.

Readonly value

value: any

Can be any JSON standard type, such as number, string, boolean, array, object, or a common API data type.

- Fields within `value` that have `null` values **are not saved**.
- For values of type [Reference](ctp:api:type:Reference) the integrity of the data is not guaranteed. If the referenced object is deleted, the API does not delete the corresponding reference to it and the `value` points to a non-existing object in such case.

Optional Readonly version

version?: number

Current version of the CustomObject.

Settings

Member Visibility

Theme

On This Page

containerkeyvalueversion