Class CustomAttributeDefinitionsService

Hierarchy

CustomAttributeDefinitionsService

Index

Constructors

Methods

createCustomAttributeDefinition createCustomAttributeDefinitionByApplicationDomain deleteCustomAttributeDefinition deleteCustomAttributeDefinitionByApplicationDomain deleteCustomAttributeDefinitionOfApplicationDomain getCustomAttributeDefinition getCustomAttributeDefinitions getCustomAttributeDefinitionsByApplicationDomain updateCustomAttributeDefinition updateCustomAttributeDefinitionByApplicationDomain

Constructors

constructor

new CustomAttributeDefinitionsService(): CustomAttributeDefinitionsService
Returns CustomAttributeDefinitionsService

Methods

`Static` createCustomAttributeDefinition

createCustomAttributeDefinition(__namedParameters: {
requestBody: CustomAttributeDefinition;
xContextId?: string;
}): CancelablePromise<CustomAttributeDefinitionResponse>
Create a custom attribute definition Use this API to create a custom attribute definition.

Token Permissions: [ custom_attribute:write ]

Returns
CustomAttributeDefinitionResponse Created a custom attribute definition. Returns the newly saved custom attribute definition in the response body.

Throws
ApiError
Parameters
- __namedParameters: {
  requestBody: CustomAttributeDefinition;
  xContextId?: string;
  }
  - requestBody: CustomAttributeDefinition
    
    The custom attribute definition. *
  - Optional xContextId?: string
    
    Optional context id the request is running. *
Returns CancelablePromise<CustomAttributeDefinitionResponse>
- Defined in packages/ep-openapi-node/generated-src/services/CustomAttributeDefinitionsService.ts:66

`Static` createCustomAttributeDefinitionByApplicationDomain

createCustomAttributeDefinitionByApplicationDomain(__namedParameters: {
    applicationDomainId: string;
    requestBody: CustomAttributeDefinition;
    xContextId?: string;
}): CancelablePromise<CustomAttributeDefinitionResponse>
Create a custom attribute definition for provided application domain Use this API to create a custom attribute definition for provided application domain.

Token Permissions: [ custom_attribute:create:* ]

Returns
CustomAttributeDefinitionResponse Created a custom attribute definition in provided application domain and Returns the newly saved custom attribute definition in the response body.

Throws
ApiError
Parameters
- __namedParameters: {
      applicationDomainId: string;
      requestBody: CustomAttributeDefinition;
      xContextId?: string;
  }
  - applicationDomainId: string
    
    The ID of the application domain *
  - requestBody: CustomAttributeDefinition
    
    The custom attribute definition. *
  - Optional xContextId?: string
    
    Optional context id the request is running. *
Returns CancelablePromise<CustomAttributeDefinitionResponse>
- Defined in packages/ep-openapi-node/generated-src/services/CustomAttributeDefinitionsService.ts:270

`Static` deleteCustomAttributeDefinition

deleteCustomAttributeDefinition(__namedParameters: {
id: string;
xContextId?: string;
}): CancelablePromise<void>
Delete a custom attribute definition Use this API to delete a custom attribute definition.

Token Permissions: [ custom_attribute:write ]

Returns
void

Throws
ApiError
Parameters
- __namedParameters: {
  id: string;
  xContextId?: string;
  }
  - id: string
    
    The ID of the custom attribute definition *
  - Optional xContextId?: string
    
    Optional context id the request is running. *
Returns CancelablePromise<void>
- Defined in packages/ep-openapi-node/generated-src/services/CustomAttributeDefinitionsService.ts:141

`Static` deleteCustomAttributeDefinitionByApplicationDomain

deleteCustomAttributeDefinitionByApplicationDomain(__namedParameters: {
applicationDomainId: string;
xContextId?: string;
}): CancelablePromise<void>
Delete a custom attribute definition of provided application domain Use this API to delete a custom attribute definition by given application domain.

Token Permissions: [ custom_attribute:delete:* ]

Returns
void

Throws
ApiError
Parameters
- __namedParameters: {
  applicationDomainId: string;
  xContextId?: string;
  }
  - applicationDomainId: string
    
    The ID of the application domain *
  - Optional xContextId?: string
    
    Optional context id the request is running. *
Returns CancelablePromise<void>
- Defined in packages/ep-openapi-node/generated-src/services/CustomAttributeDefinitionsService.ts:313

`Static` deleteCustomAttributeDefinitionOfApplicationDomain

deleteCustomAttributeDefinitionOfApplicationDomain(__namedParameters: {
    applicationDomainId: string;
    customAttributeId: string;
    xContextId?: string;
}): CancelablePromise<void>
Delete a custom attribute definition of provided application domain Use this API to delete a custom attribute definition of given application domain.

Token Permissions: [ custom_attribute:delete:* ]

Returns
void

Throws
ApiError
Parameters
- __namedParameters: {
      applicationDomainId: string;
      customAttributeId: string;
      xContextId?: string;
  }
  - applicationDomainId: string
    
    The ID of the application domain *
  - customAttributeId: string
    
    The ID of the custom attribute definition *
  - Optional xContextId?: string
    
    Optional context id the request is running. *
Returns CancelablePromise<void>
- Defined in packages/ep-openapi-node/generated-src/services/CustomAttributeDefinitionsService.ts:351

`Static` getCustomAttributeDefinition

getCustomAttributeDefinition(__namedParameters: {
id: string;
xContextId?: string;
}): CancelablePromise<CustomAttributeDefinitionResponse>
Get a custom attribute definition Use this API to get a single custom attribute definition by its ID.

Token Permissions: [ event_designer:access ]

Returns
CustomAttributeDefinitionResponse The custom attribute definition.

Throws
ApiError
Parameters
- __namedParameters: {
  id: string;
  xContextId?: string;
  }
  - id: string
    
    The ID of the custom attribute definition. *
  - Optional xContextId?: string
    
    Optional context id the request is running. *
Returns CancelablePromise<CustomAttributeDefinitionResponse>
- Defined in packages/ep-openapi-node/generated-src/services/CustomAttributeDefinitionsService.ts:103

`Static` getCustomAttributeDefinitions

getCustomAttributeDefinitions(__namedParameters: {
    associatedEntityTypes?: string[];
    pageNumber?: number;
    pageSize?: number;
    xContextId?: string;
}): CancelablePromise<CustomAttributeDefinitionsResponse>
Get a list of custom attribute definitions Use this API to get a list of custom attribute definitions that match the given parameters.

Token Permissions: [ event_designer:access ]

Returns
CustomAttributeDefinitionsResponse Get a list of custom attribute definitions and the accompanying metadata.

Throws
ApiError
Parameters
- __namedParameters: {
      associatedEntityTypes?: string[];
      pageNumber?: number;
      pageSize?: number;
      xContextId?: string;
  }
  - Optional associatedEntityTypes?: string[]
    
    Match only custom attribute definitions with the given associated entity type names separated by commas. *
  - Optional pageNumber?: number
    
    The page number to get. *
  - Optional pageSize?: number
    
    The number of custom attribute definitions to get per page. *
  - Optional xContextId?: string
    
    Optional context id the request is running. *
Returns CancelablePromise<CustomAttributeDefinitionsResponse>
- Defined in packages/ep-openapi-node/generated-src/services/CustomAttributeDefinitionsService.ts:20

`Static` getCustomAttributeDefinitionsByApplicationDomain

getCustomAttributeDefinitionsByApplicationDomain(__namedParameters: {
    applicationDomainId: string;
    pageNumber?: number;
    pageSize?: number;
    xContextId?: string;
}): CancelablePromise<CustomAttributeDefinitionsResponse>
Get a list the custom attribute definitions of provided application domain Use this API to get a list of custom attribute definitions that match the given parameters.

Token Permissions: [ custom_attribute:get:* ]

Returns
CustomAttributeDefinitionsResponse Get a list of custom attribute definitions of a given application domain id.

Throws
ApiError
Parameters
- __namedParameters: {
      applicationDomainId: string;
      pageNumber?: number;
      pageSize?: number;
      xContextId?: string;
  }
  - applicationDomainId: string
    
    Match only custom attribute definitions with the given application domain Id *
  - Optional pageNumber?: number
    
    The page number to get. *
  - Optional pageSize?: number
    
    The number of custom attribute definitions to get per page. *
  - Optional xContextId?: string
    
    Optional context id the request is running. *
Returns CancelablePromise<CustomAttributeDefinitionsResponse>
- Defined in packages/ep-openapi-node/generated-src/services/CustomAttributeDefinitionsService.ts:222

`Static` updateCustomAttributeDefinition

updateCustomAttributeDefinition(__namedParameters: {
    id: string;
    requestBody: CustomAttributeDefinition;
    xContextId?: string;
}): CancelablePromise<CustomAttributeDefinitionResponse>
Update a custom attribute definition Use this API to update a custom attribute definition. You can only update the associated entity types.

Token Permissions: [ custom_attribute:write ]

Returns
CustomAttributeDefinitionResponse The updated custom attribute definition.

Throws
ApiError
Parameters
- __namedParameters: {
      id: string;
      requestBody: CustomAttributeDefinition;
      xContextId?: string;
  }
  - id: string
    
    The ID of the custom attribute definition to update. *
  - requestBody: CustomAttributeDefinition
    
    The custom attribute definition. *
  - Optional xContextId?: string
    
    Optional context id the request is running. *
Returns CancelablePromise<CustomAttributeDefinitionResponse>
- Defined in packages/ep-openapi-node/generated-src/services/CustomAttributeDefinitionsService.ts:179

`Static` updateCustomAttributeDefinitionByApplicationDomain

updateCustomAttributeDefinitionByApplicationDomain(__namedParameters: {
    applicationDomainId: string;
    customAttributeId: string;
    requestBody: CustomAttributeDefinition;
    xContextId?: string;
}): CancelablePromise<CustomAttributeDefinitionResponse>
Update a custom attribute definition for provided application domain Use this API to update a custom attribute definition for provided application domain.

Token Permissions: [ custom_attribute:update:* ]

Returns
CustomAttributeDefinitionResponse Updated a custom attribute definition in provided application domain and Returns the newly saved custom attribute definition in the response body.

Throws
ApiError
Parameters
- __namedParameters: {
      applicationDomainId: string;
      customAttributeId: string;
      requestBody: CustomAttributeDefinition;
      xContextId?: string;
  }
  - applicationDomainId: string
    
    The ID of the application domain *
  - customAttributeId: string
    
    The ID of the custom attribute definition *
  - requestBody: CustomAttributeDefinition
    
    The custom attribute definition. *
  - Optional xContextId?: string
    
    Optional context id the request is running. *
Returns CancelablePromise<CustomAttributeDefinitionResponse>
- Defined in packages/ep-openapi-node/generated-src/services/CustomAttributeDefinitionsService.ts:393

Class CustomAttributeDefinitionsService

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Returns CustomAttributeDefinitionsService

Methods

Static createCustomAttributeDefinition

Returns

Throws

Parameters

__namedParameters: { requestBody: CustomAttributeDefinition; xContextId?: string; }

requestBody: CustomAttributeDefinition

Optional xContextId?: string

Returns CancelablePromise<CustomAttributeDefinitionResponse>

Static createCustomAttributeDefinitionByApplicationDomain

Returns

Throws

Parameters

__namedParameters: { applicationDomainId: string; requestBody: CustomAttributeDefinition; xContextId?: string; }

applicationDomainId: string

requestBody: CustomAttributeDefinition

Optional xContextId?: string

Returns CancelablePromise<CustomAttributeDefinitionResponse>

Static deleteCustomAttributeDefinition

Returns

Throws

Parameters

__namedParameters: { id: string; xContextId?: string; }

id: string

Optional xContextId?: string

Returns CancelablePromise<void>

Static deleteCustomAttributeDefinitionByApplicationDomain

Returns

Throws

Parameters

__namedParameters: { applicationDomainId: string; xContextId?: string; }

applicationDomainId: string

Optional xContextId?: string

Returns CancelablePromise<void>

Static deleteCustomAttributeDefinitionOfApplicationDomain

Returns

Throws

Parameters

__namedParameters: { applicationDomainId: string; customAttributeId: string; xContextId?: string; }

applicationDomainId: string

customAttributeId: string

Optional xContextId?: string

Returns CancelablePromise<void>

Static getCustomAttributeDefinition

Returns

Throws

Parameters

__namedParameters: { id: string; xContextId?: string; }

id: string

Optional xContextId?: string

Returns CancelablePromise<CustomAttributeDefinitionResponse>

Static getCustomAttributeDefinitions

Returns

Throws

Parameters

__namedParameters: { associatedEntityTypes?: string[]; pageNumber?: number; pageSize?: number; xContextId?: string; }

Optional associatedEntityTypes?: string[]

Optional pageNumber?: number

Optional pageSize?: number

Optional xContextId?: string

Returns CancelablePromise<CustomAttributeDefinitionsResponse>

Static getCustomAttributeDefinitionsByApplicationDomain

Returns

Throws

Parameters

__namedParameters: { applicationDomainId: string; pageNumber?: number; pageSize?: number; xContextId?: string; }

applicationDomainId: string

Optional pageNumber?: number

Optional pageSize?: number

Optional xContextId?: string

Returns CancelablePromise<CustomAttributeDefinitionsResponse>

Static updateCustomAttributeDefinition

`Static` createCustomAttributeDefinition

__namedParameters: {
requestBody: CustomAttributeDefinition;
xContextId?: string;
}

`Optional` xContextId?: string

`Static` createCustomAttributeDefinitionByApplicationDomain

__namedParameters: {
applicationDomainId: string;
requestBody: CustomAttributeDefinition;
xContextId?: string;
}

`Optional` xContextId?: string

`Static` deleteCustomAttributeDefinition

__namedParameters: {
id: string;
xContextId?: string;
}

`Optional` xContextId?: string

`Static` deleteCustomAttributeDefinitionByApplicationDomain

__namedParameters: {
applicationDomainId: string;
xContextId?: string;
}

`Optional` xContextId?: string

`Static` deleteCustomAttributeDefinitionOfApplicationDomain

__namedParameters: {
applicationDomainId: string;
customAttributeId: string;
xContextId?: string;
}

`Optional` xContextId?: string

`Static` getCustomAttributeDefinition

__namedParameters: {
id: string;
xContextId?: string;
}

`Optional` xContextId?: string

`Static` getCustomAttributeDefinitions

__namedParameters: {
associatedEntityTypes?: string[];
pageNumber?: number;
pageSize?: number;
xContextId?: string;
}

`Optional` associatedEntityTypes?: string[]

`Optional` pageNumber?: number

`Optional` pageSize?: number

`Optional` xContextId?: string

`Static` getCustomAttributeDefinitionsByApplicationDomain

__namedParameters: {
applicationDomainId: string;
pageNumber?: number;
pageSize?: number;
xContextId?: string;
}

`Optional` pageNumber?: number

`Optional` pageSize?: number

`Optional` xContextId?: string

`Static` updateCustomAttributeDefinition

__namedParameters: {
id: string;
requestBody: CustomAttributeDefinition;
xContextId?: string;
}

`Optional` xContextId?: string

`Static` updateCustomAttributeDefinitionByApplicationDomain

__namedParameters: {
applicationDomainId: string;
customAttributeId: string;
requestBody: CustomAttributeDefinition;
xContextId?: string;
}

`Optional` xContextId?: string