Class CoreApi

Index

Constructors

Methods

archive archiveAssociation archiveAssociationWithHttpInfo archiveWithHttpInfo create createAssociation createAssociationWithHttpInfo createWithHttpInfo getAll getAllWithHttpInfo getById getByIdWithHttpInfo update updateWithHttpInfo

Constructors

constructor

new CoreApi(configuration, requestFactory?, responseProcessor?): CoreApi
Parameters
- configuration: Configuration<ObservableMiddleware>
- OptionalrequestFactory: CoreApiRequestFactory
- OptionalresponseProcessor: CoreApiResponseProcessor
Returns CoreApi
- Defined in codegen/crm/schemas/types/PromiseAPI.ts:18

Methods

archiveAssociation

archiveAssociation(objectType, associationIdentifier, _options?): Promise<void>
Removes an existing association from a schema. Remove an association
Parameters
- objectType: string
  Fully qualified name or object type ID of your schema.
- associationIdentifier: string
  Unique ID of the association to remove.
- Optional_options: PromiseConfigurationOptions
Returns Promise<void>
- Defined in codegen/crm/schemas/types/PromiseAPI.ts:101

archiveAssociationWithHttpInfo

archiveAssociationWithHttpInfo(objectType, associationIdentifier, _options?): Promise<HttpInfo<void>>
Removes an existing association from a schema. Remove an association
Parameters
- objectType: string
  Fully qualified name or object type ID of your schema.
- associationIdentifier: string
  Unique ID of the association to remove.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<void>>
- Defined in codegen/crm/schemas/types/PromiseAPI.ts:78

archiveWithHttpInfo

archiveWithHttpInfo(objectType, archived?, _options?): Promise<HttpInfo<void>>
Deletes a schema. Any existing records of this schema must be deleted first. Otherwise this call will fail. Delete a schema
Parameters
- objectType: string
  Fully qualified name or object type ID of your schema.
- Optionalarchived: boolean
  Whether to return only results that have been archived.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<void>>
- Defined in codegen/crm/schemas/types/PromiseAPI.ts:32

create

create(objectSchemaEgg, _options?): Promise<ObjectSchema>
Define a new object schema, along with custom properties and associations. The entire object schema, including its object type ID, properties, and associations will be returned in the response. Create a new schema
Parameters
- objectSchemaEgg: ObjectSchemaEgg
  Object schema definition, including properties and associations.
- Optional_options: PromiseConfigurationOptions
Returns Promise<ObjectSchema>
- Defined in codegen/crm/schemas/types/PromiseAPI.ts:145

createAssociation

createAssociation(objectType, associationDefinitionEgg, _options?): Promise<AssociationDefinition>
Defines a new association between the primary schema's object type and other object types. Create an association
Parameters
- objectType: string
  Fully qualified name or object type ID of your schema.
- associationDefinitionEgg: AssociationDefinitionEgg
  Attributes that define the association.
- Optional_options: PromiseConfigurationOptions
Returns Promise<AssociationDefinition>
- Defined in codegen/crm/schemas/types/PromiseAPI.ts:191

createAssociationWithHttpInfo

createAssociationWithHttpInfo(objectType, associationDefinitionEgg, _options?): Promise<HttpInfo<AssociationDefinition>>
Defines a new association between the primary schema's object type and other object types. Create an association
Parameters
- objectType: string
  Fully qualified name or object type ID of your schema.
- associationDefinitionEgg: AssociationDefinitionEgg
  Attributes that define the association.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<AssociationDefinition>>
- Defined in codegen/crm/schemas/types/PromiseAPI.ts:168

createWithHttpInfo

createWithHttpInfo(objectSchemaEgg, _options?): Promise<HttpInfo<ObjectSchema>>
Define a new object schema, along with custom properties and associations. The entire object schema, including its object type ID, properties, and associations will be returned in the response. Create a new schema
Parameters
- objectSchemaEgg: ObjectSchemaEgg
  Object schema definition, including properties and associations.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<ObjectSchema>>
- Defined in codegen/crm/schemas/types/PromiseAPI.ts:123

getAll

getAll(archived?, _options?): Promise<CollectionResponseObjectSchemaNoPaging>
Returns all object schemas that have been defined for your account. Get all schemas
Parameters
- Optionalarchived: boolean
  Whether to return only results that have been archived.
- Optional_options: PromiseConfigurationOptions
Returns Promise<CollectionResponseObjectSchemaNoPaging>
- Defined in codegen/crm/schemas/types/PromiseAPI.ts:235

getAllWithHttpInfo

getAllWithHttpInfo(archived?, _options?): Promise<HttpInfo<CollectionResponseObjectSchemaNoPaging>>
Returns all object schemas that have been defined for your account. Get all schemas
Parameters
- Optionalarchived: boolean
  Whether to return only results that have been archived.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<CollectionResponseObjectSchemaNoPaging>>
- Defined in codegen/crm/schemas/types/PromiseAPI.ts:213

getById

getById(objectType, _options?): Promise<ObjectSchema>
Returns an existing object schema. Get an existing schema
Parameters
- objectType: string
  Fully qualified name or object type ID of your schema.
- Optional_options: PromiseConfigurationOptions
Returns Promise<ObjectSchema>
- Defined in codegen/crm/schemas/types/PromiseAPI.ts:279

getByIdWithHttpInfo

getByIdWithHttpInfo(objectType, _options?): Promise<HttpInfo<ObjectSchema>>
Returns an existing object schema. Get an existing schema
Parameters
- objectType: string
  Fully qualified name or object type ID of your schema.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<ObjectSchema>>
- Defined in codegen/crm/schemas/types/PromiseAPI.ts:257

update

update(objectType, objectTypeDefinitionPatch, _options?): Promise<ObjectTypeDefinition>
Update the details for an existing object schema. Update a schema
Parameters
- objectType: string
  Fully qualified name or object type ID of your schema.
- objectTypeDefinitionPatch: ObjectTypeDefinitionPatch
  Attributes to update in your schema.
- Optional_options: PromiseConfigurationOptions
Returns Promise<ObjectTypeDefinition>
- Defined in codegen/crm/schemas/types/PromiseAPI.ts:325

updateWithHttpInfo

updateWithHttpInfo(objectType, objectTypeDefinitionPatch, _options?): Promise<HttpInfo<ObjectTypeDefinition>>
Update the details for an existing object schema. Update a schema
Parameters
- objectType: string
  Fully qualified name or object type ID of your schema.
- objectTypeDefinitionPatch: ObjectTypeDefinitionPatch
  Attributes to update in your schema.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<ObjectTypeDefinition>>
- Defined in codegen/crm/schemas/types/PromiseAPI.ts:302

Class CoreApi

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns CoreApi

Methods

archive

Parameters

Returns Promise<void>

archiveAssociation

Parameters

Returns Promise<void>

archiveAssociationWithHttpInfo

Parameters

Returns Promise<HttpInfo<void>>

archiveWithHttpInfo

Parameters

Returns Promise<HttpInfo<void>>

create

Parameters

Returns Promise<ObjectSchema>

createAssociation

Parameters

Returns Promise<AssociationDefinition>

createAssociationWithHttpInfo

Parameters

Returns Promise<HttpInfo<AssociationDefinition>>

createWithHttpInfo

Parameters

Returns Promise<HttpInfo<ObjectSchema>>

getAll

Parameters

Returns Promise<CollectionResponseObjectSchemaNoPaging>

getAllWithHttpInfo

Parameters

Returns Promise<HttpInfo<CollectionResponseObjectSchemaNoPaging>>

getById

Parameters

Returns Promise<ObjectSchema>

getByIdWithHttpInfo

Parameters

Returns Promise<HttpInfo<ObjectSchema>>

update

Parameters

Returns Promise<ObjectTypeDefinition>

updateWithHttpInfo

Parameters

Returns Promise<HttpInfo<ObjectTypeDefinition>>

Settings

On This Page