Class DefinitionsApi

Hierarchy

DefinitionsApi

Index

Constructors

constructor

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

Properties

`Private` api

api: ObservableDefinitionsApi

Methods

_delete

_delete(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:27

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:39

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:50

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:62

Class DefinitionsApi

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

configuration: Configuration

Optional requestFactory: DefinitionsApiRequestFactory

Optional responseProcessor: DefinitionsApiResponseProcessor

Returns DefinitionsApi

Properties

Private api

Methods

_delete

Parameters

fromObjectType: string

toObjectType: string

associationTypeId: number

Optional _options: Configuration

Returns Promise<void>

create

Parameters

fromObjectType: string

toObjectType: string

publicAssociationDefinitionCreateRequest: PublicAssociationDefinitionCreateRequest

Optional _options: Configuration

Returns Promise<CollectionResponseAssociationSpecWithLabelNoPaging>

getAll

Parameters

fromObjectType: string

toObjectType: string

Optional _options: Configuration

Returns Promise<CollectionResponseAssociationSpecWithLabelNoPaging>

update

Parameters

fromObjectType: string

toObjectType: string

publicAssociationDefinitionUpdateRequest: PublicAssociationDefinitionUpdateRequest

Optional _options: Configuration

Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

`Optional` requestFactory: DefinitionsApiRequestFactory

`Optional` responseProcessor: DefinitionsApiResponseProcessor

`Private` api

`Optional` _options: Configuration

`Optional` _options: Configuration

`Optional` _options: Configuration

`Optional` _options: Configuration