Function: createObjectType()
ts
function createObjectType(
client,
parameters,
options?
): Promise<{
[key: string]: unknown;
abstractObjectType: boolean;
created: Date;
description?: string;
globalId: string;
icon: {
[key: string]: unknown;
id: string;
name: string;
url16: string;
url48: string;
};
id: string;
inherited: boolean;
name: string;
objectCount: number;
objectSchemaId: string;
parentObjectTypeId?: number;
parentObjectTypeInherited: boolean;
position: number;
type?: number;
updated: Date;
workspaceId: string;
}>;Defined in: src/assets/api/objectTypes.ts:113
Create a new object type
Parameters
| Parameter | Type | Description |
|---|---|---|
client | Client | - |
parameters | { abstractObjectType?: boolean; description?: string; iconId: string; inherited?: boolean; name: string; objectSchemaId: string; parentObjectTypeId?: string; } | - |
parameters.abstractObjectType? | boolean | - |
parameters.description? | string | - |
parameters.iconId? | string | - |
parameters.inherited? | boolean | Describes if this object type is configured for inheritance i.e. it's children inherits the attributes of this object type |
parameters.name? | string | - |
parameters.objectSchemaId? | string | - |
parameters.parentObjectTypeId? | string | The id of the parent object type |
options? | RequestOptions | - |
Returns
Promise<{ [key: string]: unknown; abstractObjectType: boolean; created: Date; description?: string; globalId: string; icon: { [key: string]: unknown; id: string; name: string; url16: string; url48: string; }; id: string; inherited: boolean; name: string; objectCount: number; objectSchemaId: string; parentObjectTypeId?: number; parentObjectTypeInherited: boolean; position: number; type?: number; updated: Date; workspaceId: string; }>