Class DefinitionsApi

Index

Constructors

Methods

create createWithHttpInfo getAll getAllWithHttpInfo remove removeWithHttpInfo update updateWithHttpInfo

Constructors

constructor

new DefinitionsApi(configuration, requestFactory?, responseProcessor?): DefinitionsApi
Parameters
- configuration: Configuration<ObservableMiddleware>
- OptionalrequestFactory: DefinitionsApiRequestFactory
- OptionalresponseProcessor: DefinitionsApiResponseProcessor
Returns DefinitionsApi
- Defined in codegen/crm/associations/v4/schema/types/PromiseAPI.ts:273

Methods

create

create(fromObjectType, toObjectType, publicAssociationDefinitionCreateRequest, _options?): Promise<CollectionResponseAssociationSpecWithLabelNoPaging>
Create a user defined association definition Create
Parameters
- fromObjectType: string
- toObjectType: string
- publicAssociationDefinitionCreateRequest: PublicAssociationDefinitionCreateRequest
- Optional_options: PromiseConfigurationOptions
Returns Promise<CollectionResponseAssociationSpecWithLabelNoPaging>
- Defined in codegen/crm/associations/v4/schema/types/PromiseAPI.ts:312

createWithHttpInfo

createWithHttpInfo(fromObjectType, toObjectType, publicAssociationDefinitionCreateRequest, _options?): Promise<HttpInfo<CollectionResponseAssociationSpecWithLabelNoPaging>>
Create a user defined association definition Create
Parameters
- fromObjectType: string
- toObjectType: string
- publicAssociationDefinitionCreateRequest: PublicAssociationDefinitionCreateRequest
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<CollectionResponseAssociationSpecWithLabelNoPaging>>
- Defined in codegen/crm/associations/v4/schema/types/PromiseAPI.ts:288

getAll

getAll(fromObjectType, toObjectType, _options?): Promise<CollectionResponseAssociationSpecWithLabelNoPaging>
Returns all association types between two object types Read
Parameters
- fromObjectType: string
- toObjectType: string
- Optional_options: PromiseConfigurationOptions
Returns Promise<CollectionResponseAssociationSpecWithLabelNoPaging>
- Defined in codegen/crm/associations/v4/schema/types/PromiseAPI.ts:358

getAllWithHttpInfo

getAllWithHttpInfo(fromObjectType, toObjectType, _options?): Promise<HttpInfo<CollectionResponseAssociationSpecWithLabelNoPaging>>
Returns all association types between two object types Read
Parameters
- fromObjectType: string
- toObjectType: string
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<CollectionResponseAssociationSpecWithLabelNoPaging>>
- Defined in codegen/crm/associations/v4/schema/types/PromiseAPI.ts:335

remove

remove(fromObjectType, toObjectType, associationTypeId, _options?): Promise<void>
Deletes an association definition Delete
Parameters
- fromObjectType: string
- toObjectType: string
- associationTypeId: number
- Optional_options: PromiseConfigurationOptions
Returns Promise<void>
- Defined in codegen/crm/associations/v4/schema/types/PromiseAPI.ts:406

removeWithHttpInfo

removeWithHttpInfo(fromObjectType, toObjectType, associationTypeId, _options?): Promise<HttpInfo<void>>
Deletes an association definition Delete
Parameters
- fromObjectType: string
- toObjectType: string
- associationTypeId: number
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<void>>
- Defined in codegen/crm/associations/v4/schema/types/PromiseAPI.ts:382

update

update(fromObjectType, toObjectType, publicAssociationDefinitionUpdateRequest, _options?): Promise<void>
Update a user defined association definition Update
Parameters
- fromObjectType: string
- toObjectType: string
- publicAssociationDefinitionUpdateRequest: PublicAssociationDefinitionUpdateRequest
- Optional_options: PromiseConfigurationOptions
Returns Promise<void>
- Defined in codegen/crm/associations/v4/schema/types/PromiseAPI.ts:454

updateWithHttpInfo

updateWithHttpInfo(fromObjectType, toObjectType, publicAssociationDefinitionUpdateRequest, _options?): Promise<HttpInfo<void>>
Update a user defined association definition Update
Parameters
- fromObjectType: string
- toObjectType: string
- publicAssociationDefinitionUpdateRequest: PublicAssociationDefinitionUpdateRequest
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<void>>
- Defined in codegen/crm/associations/v4/schema/types/PromiseAPI.ts:430