Class EntitiesClientCreateOptionsAbstract

The contract used to specify the options for POST calls for Entities.

Constructors

constructor

Properties

apiVersion? entityName id? object relation? skipHydrateRelationships? suffix?

Constructors

constructor

Properties

Optional apiVersion

apiVersion?: API_VERSION

Ignored for Create calls.

entityName

entityName: string

The entity type of the object being created. e.g. 'item'

Optional id

id?: string

Deprecated

Use suffix for adding a suffix to the resource path.

object

object: any

The entity object being created.

Optional relation

relation?: string

Deprecated

use suffix instead.

Optional skipHydrateRelationships

skipHydrateRelationships?: boolean

Returns only the updated entity, without hydrated object and type references

As of 2025-07-18, only supported by Project Items. Other entities will ignore this and return the full hydrated object.

Optional suffix

suffix?: string

Used to specify a suffix to the resource path.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc