Class EnumsService

Hierarchy

EnumsService

Index

Constructors

Methods

createEnum createEnumVersion deleteEnum deleteEnumVersion getEnum getEnumVersion getEnumVersions getEnums updateEnum updateEnumVersion updateEnumVersionState

Constructors

constructor

new EnumsService(): EnumsService
Returns EnumsService

Methods

`Static` createEnum

createEnum(__namedParameters: {
requestBody: TopicAddressEnum;
xContextId?: string;
}): CancelablePromise<TopicAddressEnumResponse>
Create an enumeration An enumeration is a bounded variable with a limited set of literal values. Use this API to create an enumeration to define acceptable values for a level in a topic address or topic domain.

Token Permissions: [ ep_enum:create:* ]

Returns
TopicAddressEnumResponse Created an enumeration. The newly saved enumeration is returned in the response body.

Throws
ApiError
Parameters
- __namedParameters: {
  requestBody: TopicAddressEnum;
  xContextId?: string;
  }
  - requestBody: TopicAddressEnum
    
    Enumeration description. *
  - Optional xContextId?: string
    
    Optional context id the request is running. *
Returns CancelablePromise<TopicAddressEnumResponse>
- Defined in packages/ep-openapi-node/generated-src/services/EnumsService.ts:95

`Static` createEnumVersion

createEnumVersion(__namedParameters: {
requestBody: TopicAddressEnumVersion;
xContextId?: string;
}): CancelablePromise<TopicAddressEnumVersionResponse>
Create an enumeration version Create an enumeration version.

Token Permissions: [ ep_enum:update:* ]

Returns
TopicAddressEnumVersionResponse Created an enumeration version and its values. The newly saved enumeration version is returned in the response body.

Throws
ApiError
Parameters
- __namedParameters: {
  requestBody: TopicAddressEnumVersion;
  xContextId?: string;
  }
  - requestBody: TopicAddressEnumVersion
    
    Enumeration version description with its values. *
  - Optional xContextId?: string
    
    Optional context id the request is running. *
Returns CancelablePromise<TopicAddressEnumVersionResponse>
- Defined in packages/ep-openapi-node/generated-src/services/EnumsService.ts:301

`Static` deleteEnum

deleteEnum(__namedParameters: {
id: string;
xContextId?: string;
}): CancelablePromise<void>
Delete an enumeration Use this API to delete an enumeration. The enumeration must not have any versions or else it cannot be deleted.

Token Permissions: [ ep_enum:delete:* ]

Returns
void

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

`Static` deleteEnumVersion

deleteEnumVersion(__namedParameters: {
id: string;
xContextId?: string;
}): CancelablePromise<void>
Delete an enumeration version Use this API to delete an enumeration version. The version must not be in use by any events else it cannot be deleted. This also deletes the version's values.

Token Permissions: [ ep_enum:update:* ]

Returns
void

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

`Static` getEnum

getEnum(__namedParameters: {
id: string;
xContextId?: string;
}): CancelablePromise<TopicAddressEnumResponse>
Get an enumeration Use this API to get a single enumeration by its ID.

Token Permissions: [ ep_enum:get:* ]

Returns
TopicAddressEnumResponse The enumeration.

Throws
ApiError
Parameters
- __namedParameters: {
  id: string;
  xContextId?: string;
  }
  - id: string
    
    The ID of the enumeration. *
  - Optional xContextId?: string
    
    Optional context id the request is running. *
Returns CancelablePromise<TopicAddressEnumResponse>
- Defined in packages/ep-openapi-node/generated-src/services/EnumsService.ts:132

`Static` getEnumVersion

getEnumVersion(__namedParameters: {
versionId: string;
xContextId?: string;
}): CancelablePromise<TopicAddressEnumVersionResponse>
Get an enumeration version Use this API to get a single enumeration version by its ID.

Token Permissions: [ ep_enum:get:* ]

Returns
TopicAddressEnumVersionResponse The enumeration version.

Throws
ApiError
Parameters
- __namedParameters: {
  versionId: string;
  xContextId?: string;
  }
  - versionId: string
    
    The ID of the enumeration version. *
  - Optional xContextId?: string
    
    Optional context id the request is running. *
Returns CancelablePromise<TopicAddressEnumVersionResponse>
- Defined in packages/ep-openapi-node/generated-src/services/EnumsService.ts:462

`Static` getEnumVersions

getEnumVersions(__namedParameters: {
    enumIds?: string[];
    ids?: string[];
    pageNumber?: number;
    pageSize?: number;
    xContextId?: string;
}): CancelablePromise<TopicAddressEnumVersionsResponse>
Get a list of enumeration versions Use this API to get a list of enumeration versions that match the given parameters.

Token Permissions: [ event_designer:access ]

Returns
TopicAddressEnumVersionsResponse Get a list of enumeration versions and the accompanying metadata.

Throws
ApiError
Parameters
- __namedParameters: {
      enumIds?: string[];
      ids?: string[];
      pageNumber?: number;
      pageSize?: number;
      xContextId?: string;
  }
  - Optional enumIds?: string[]
    
    Match only enumeration versions of these enumeration IDs, separated by commas. *
  - Optional ids?: string[]
    
    Match only enumeration versions with the given IDs, separated by commas. *
  - Optional pageNumber?: number
    
    The page number to get. *
  - Optional pageSize?: number
    
    The number of enumeration versions to get per page. *
  - Optional xContextId?: string
    
    Optional context id the request is running. *
Returns CancelablePromise<TopicAddressEnumVersionsResponse>
- Defined in packages/ep-openapi-node/generated-src/services/EnumsService.ts:251

`Static` getEnums

getEnums(__namedParameters: {
    applicationDomainId?: string;
    applicationDomainIds?: string[];
    customAttributes?: string;
    ids?: string[];
    names?: string[];
    pageNumber?: number;
    pageSize?: number;
    shared?: boolean;
    sort?: string;
    xContextId?: string;
}): CancelablePromise<TopicAddressEnumsResponse>
Get a list of enumerations Use this API to get a list of enumerations based on certain criteria.

Token Permissions: [ event_designer:access ]

Returns
TopicAddressEnumsResponse Get a list of enumerations and the accompanying metadata.

Throws
ApiError
Parameters
- __namedParameters: {
      applicationDomainId?: string;
      applicationDomainIds?: string[];
      customAttributes?: string;
      ids?: string[];
      names?: string[];
      pageNumber?: number;
      pageSize?: number;
      shared?: boolean;
      sort?: string;
      xContextId?: string;
  }
  - Optional applicationDomainId?: string
    
    The application domain ID of the enumerations. *
  - Optional applicationDomainIds?: string[]
    
    Match only enumerations in the given application domain ids. *
  - Optional customAttributes?: string
    
    Returns the entities that match the custom attribute filter.
    To filter by custom attribute name and value, use the format: customAttributes=<custom-attribute-name>==<custom-attribute-value>.
    To filter by custom attribute name, use the format: customAttributes=<custom-attribute-name>.
    The filter supports the AND operator for multiple custom attribute definitions (not multiple values for a given definition). Use ; (semicolon) to separate multiple queries with AND operation.
    Note: the filter supports custom attribute values containing only the characters [a-zA-Z0-9_\-\. ]. *
  - Optional ids?: string[]
    
    The IDs of the enumerations. *
  - Optional names?: string[]
    
    The names of the enumerations. *
  - Optional pageNumber?: number
    
    The page number to get. *
  - Optional pageSize?: number
    
    The number of enumerations to get per page. *
  - Optional shared?: boolean
    
    Match only with shared or unshared enumerations. *
  - Optional sort?: string
    
    Sort based on the provided parameters.
    The value can be either a standalone field name (?sort=<field>) or a field and direction, delimited by a colon (?sort=<field>:<asc|desc>). If the direction is not specified, the default is ascending. *
  - Optional xContextId?: string
    
    Optional context id the request is running. *
Returns CancelablePromise<TopicAddressEnumsResponse>
- Defined in packages/ep-openapi-node/generated-src/services/EnumsService.ts:25

`Static` updateEnum

updateEnum(__namedParameters: {
    id: string;
    requestBody: TopicAddressEnum;
    xContextId?: string;
}): CancelablePromise<TopicAddressEnumResponse>
Update an enumeration Use this API to update an enumeration object. You only need to specify the fields that need to be updated.

Token Permissions: [ ep_enum:update:* ]

Returns
TopicAddressEnumResponse Updated an enumeration. The newly saved enumeration is returned in the response body.

Throws
ApiError
Parameters
- __namedParameters: {
      id: string;
      requestBody: TopicAddressEnum;
      xContextId?: string;
  }
  - id: string
    
    The ID of the enumeration. *
  - requestBody: TopicAddressEnum
    
    Enumeration updates. *
  - Optional xContextId?: string
    
    Optional context id the request is running. *
Returns CancelablePromise<TopicAddressEnumResponse>
- Defined in packages/ep-openapi-node/generated-src/services/EnumsService.ts:208

`Static` updateEnumVersion

updateEnumVersion(__namedParameters: {
    id: string;
    requestBody: TopicAddressEnumVersion;
    xContextId?: string;
}): CancelablePromise<TopicAddressEnumVersionResponse>
Update an enumeration version Use this API to update an enumeration version. You only need to specify the fields that need to be updated.

Token Permissions: [ ep_enum:update:* ]

Returns
TopicAddressEnumVersionResponse The updated enumeration version.

Throws
ApiError
Parameters
- __namedParameters: {
      id: string;
      requestBody: TopicAddressEnumVersion;
      xContextId?: string;
  }
  - id: string
    
    The ID of the enumeration version to update. *
  - requestBody: TopicAddressEnumVersion
    
    The enumeration version. *
  - Optional xContextId?: string
    
    Optional context id the request is running. *
Returns CancelablePromise<TopicAddressEnumVersionResponse>
- Defined in packages/ep-openapi-node/generated-src/services/EnumsService.ts:376

`Static` updateEnumVersionState

updateEnumVersionState(__namedParameters: {
    id: string;
    requestBody: VersionedObjectStateChangeRequest;
    xContextId?: string;
}): CancelablePromise<StateChangeRequestResponse>
Update the state of an enumeration version Use this API to update the state of an enumeration version. You only need to specify the target stateId field.

Token Permissions: [ ep_enum:update_state:* ]

Returns
StateChangeRequestResponse The updated state of the enumeration version.

Throws
ApiError
Parameters
- __namedParameters: {
      id: string;
      requestBody: VersionedObjectStateChangeRequest;
      xContextId?: string;
  }
  - id: string
    
    The ID of the enumeration version to update. *
  - requestBody: VersionedObjectStateChangeRequest
    
    The state object. *
  - Optional xContextId?: string
    
    Optional context id the request is running. *
Returns CancelablePromise<StateChangeRequestResponse>
- Defined in packages/ep-openapi-node/generated-src/services/EnumsService.ts:419

Class EnumsService

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Returns EnumsService

Methods

Static createEnum

Returns

Throws

Parameters

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

requestBody: TopicAddressEnum

Optional xContextId?: string

Returns CancelablePromise<TopicAddressEnumResponse>

Static createEnumVersion

Returns

Throws

Parameters

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

requestBody: TopicAddressEnumVersion

Optional xContextId?: string

Returns CancelablePromise<TopicAddressEnumVersionResponse>

Static deleteEnum

Returns

Throws

Parameters

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

id: string

Optional xContextId?: string

Returns CancelablePromise<void>

Static deleteEnumVersion

Returns

Throws

Parameters

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

id: string

Optional xContextId?: string

Returns CancelablePromise<void>

Static getEnum

Returns

Throws

Parameters

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

id: string

Optional xContextId?: string

Returns CancelablePromise<TopicAddressEnumResponse>

Static getEnumVersion

Returns

Throws

Parameters

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

versionId: string

Optional xContextId?: string

Returns CancelablePromise<TopicAddressEnumVersionResponse>

Static getEnumVersions

Returns

Throws

Parameters

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

Optional enumIds?: string[]

Optional ids?: string[]

Optional pageNumber?: number

Optional pageSize?: number

Optional xContextId?: string

Returns CancelablePromise<TopicAddressEnumVersionsResponse>

Static getEnums

Returns

Throws

Parameters

__namedParameters: { applicationDomainId?: string; applicationDomainIds?: string[]; customAttributes?: string; ids?: string[]; names?: string[]; pageNumber?: number; pageSize?: number; shared?: boolean; sort?: string; xContextId?: string; }

Optional applicationDomainId?: string

Optional applicationDomainIds?: string[]

Optional customAttributes?: string

Optional ids?: string[]

Optional names?: string[]

Optional pageNumber?: number

Optional pageSize?: number

`Static` createEnum

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

`Optional` xContextId?: string

`Static` createEnumVersion

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

`Optional` xContextId?: string

`Static` deleteEnum

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

`Optional` xContextId?: string

`Static` deleteEnumVersion

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

`Optional` xContextId?: string

`Static` getEnum

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

`Optional` xContextId?: string

`Static` getEnumVersion

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

`Optional` xContextId?: string

`Static` getEnumVersions

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

`Optional` enumIds?: string[]

`Optional` ids?: string[]

`Optional` pageNumber?: number

`Optional` pageSize?: number

`Optional` xContextId?: string

`Static` getEnums

__namedParameters: {
applicationDomainId?: string;
applicationDomainIds?: string[];
customAttributes?: string;
ids?: string[];
names?: string[];
pageNumber?: number;
pageSize?: number;
shared?: boolean;
sort?: string;
xContextId?: string;
}

`Optional` applicationDomainId?: string

`Optional` applicationDomainIds?: string[]

`Optional` customAttributes?: string

`Optional` ids?: string[]

`Optional` names?: string[]

`Optional` pageNumber?: number

`Optional` pageSize?: number

`Optional` shared?: boolean

`Optional` sort?: string

`Optional` xContextId?: string

`Static` updateEnum

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

`Optional` xContextId?: string

`Static` updateEnumVersion

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

`Optional` xContextId?: string

`Static` updateEnumVersionState

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

`Optional` xContextId?: string