Class DefinitionsApi

Index

Constructors

Methods

archive archiveWithHttpInfo create createWithHttpInfo getAll getAllWithHttpInfo update updateWithHttpInfo

Constructors

constructor

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

Methods

archive

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

archiveWithHttpInfo

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

create

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

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: Configuration
Returns Promise<HttpInfo<CollectionResponseAssociationSpecWithLabelNoPaging>>
- Defined in codegen/crm/associations/v4/schema/types/PromiseAPI.ts:52

getAll

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

getAllWithHttpInfo

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

update

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

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: Configuration
Returns Promise<HttpInfo<void>>
- Defined in codegen/crm/associations/v4/schema/types/PromiseAPI.ts:98