Class SchemasService

Hierarchy

SchemasService

Index

Constructors

Methods

createSchema createSchemaVersion deleteSchema deleteSchemaVersion getSchema getSchemaVersion getSchemaVersions getSchemas updateSchema updateSchemaVersion updateSchemaVersionState

Constructors

constructor

new SchemasService(): SchemasService
Returns SchemasService

Methods

`Static` createSchema

createSchema(__namedParameters: {
requestBody: SchemaObject;
xContextId?: string;
}): CancelablePromise<SchemaResponse>
Create a schema To model your event-driven architecture, schemas are a fundamental building block for modelling the payloads of the events flowing through your system. Use this API to create schemas that can later be referenced by events.

Token Permissions: [ schema:create:* ]

Returns
SchemaResponse Created a schema. The newly saved schema is returned in the response body.

Throws
ApiError
Parameters
- __namedParameters: {
  requestBody: SchemaObject;
  xContextId?: string;
  }
  - requestBody: SchemaObject
    
    The schema requires a name, an application domain, a schema type and a content type. *
  - Optional xContextId?: string
    
    Optional context id the request is running. *
Returns CancelablePromise<SchemaResponse>
- Defined in packages/ep-openapi-node/generated-src/services/SchemasService.ts:99

`Static` createSchemaVersion

createSchemaVersion(__namedParameters: {
requestBody: SchemaVersion;
xContextId?: string;
}): CancelablePromise<SchemaVersionResponse>
Create a schema version Creates a schema version

Token Permissions: [ schema:update:* ]

Returns
SchemaVersionResponse Created a schema version. The newly saved schema version is returned in the response body.

Throws
ApiError
Parameters
- __namedParameters: {
  requestBody: SchemaVersion;
  xContextId?: string;
  }
  - requestBody: SchemaVersion
    
    schema version details *
  - Optional xContextId?: string
    
    Optional context id the request is running. *
Returns CancelablePromise<SchemaVersionResponse>
- Defined in packages/ep-openapi-node/generated-src/services/SchemasService.ts:309

`Static` deleteSchema

deleteSchema(__namedParameters: {
id: string;
xContextId?: string;
}): CancelablePromise<void>
Delete a schema Use this API to delete a schema. The schema must not be in use by any events else it cannot be deleted.

Token Permissions: [ schema:delete:* ]

Returns
void

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

`Static` deleteSchemaVersion

deleteSchemaVersion(__namedParameters: {
id: string;
xContextId?: string;
}): CancelablePromise<void>
Delete a schema version Use this API to delete a schema version.

Token Permissions: [ schema:update:* ]

Returns
void

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

`Static` getSchema

getSchema(__namedParameters: {
id: string;
xContextId?: string;
}): CancelablePromise<SchemaResponse>
Get a schema Use this API to get a single schema by its ID.

Token Permissions: [ schema:get:* ]

Returns
SchemaResponse The schema.

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

`Static` getSchemaVersion

getSchemaVersion(__namedParameters: {
versionId: string;
xContextId?: string;
}): CancelablePromise<SchemaVersionResponse>
Get a schema version Use this API to get a single schema version by its ID.

Token Permissions: [ schema:get:* ]

Returns
SchemaVersionResponse The schema version.

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

`Static` getSchemaVersions

getSchemaVersions(__namedParameters: {
    customAttributes?: string;
    ids?: string[];
    pageNumber?: number;
    pageSize?: number;
    schemaIds?: string[];
    xContextId?: string;
}): CancelablePromise<SchemaVersionsResponse>
Get a list of schema versions Use this API to get a list of schema versions that match the given parameters.

Token Permissions: [ event_designer:access ]

Returns
SchemaVersionsResponse Get a list of schema versions and the accompanying metadata.

Throws
ApiError
Parameters
- __namedParameters: {
      customAttributes?: string;
      ids?: string[];
      pageNumber?: number;
      pageSize?: number;
      schemaIds?: string[];
      xContextId?: string;
  }
  - 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[]
    
    Match only schema versions with the given IDs, separated by commas. *
  - Optional pageNumber?: number
    
    The page number to get. *
  - Optional pageSize?: number
    
    The number of schema versions to get per page. *
  - Optional schemaIds?: string[]
    
    Match only schema versions of these schema IDs, separated by commas. *
  - Optional xContextId?: string
    
    Optional context id the request is running. *
Returns CancelablePromise<SchemaVersionsResponse>
- Defined in packages/ep-openapi-node/generated-src/services/SchemasService.ts:255

`Static` getSchemas

getSchemas(__namedParameters: {
    applicationDomainId?: string;
    applicationDomainIds?: string[];
    customAttributes?: string;
    ids?: string[];
    name?: string;
    pageNumber?: number;
    pageSize?: number;
    schemaType?: string;
    shared?: boolean;
    sort?: string;
    xContextId?: string;
}): CancelablePromise<SchemasResponse>
Get a list of schemas Use this API to get a list of schemas that match the given parameters.

Token Permissions: [ event_designer:access ]

Returns
SchemasResponse Get a list of schemas and the accompanying metadata.

Throws
ApiError
Parameters
- __namedParameters: {
      applicationDomainId?: string;
      applicationDomainIds?: string[];
      customAttributes?: string;
      ids?: string[];
      name?: string;
      pageNumber?: number;
      pageSize?: number;
      schemaType?: string;
      shared?: boolean;
      sort?: string;
      xContextId?: string;
  }
  - Optional applicationDomainId?: string
    
    Match only schemas in the given application domain. *
  - Optional applicationDomainIds?: string[]
    
    Match only schemas 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[]
    
    Match only schemas with the given IDs separated by commas. *
  - Optional name?: string
    
    Name of the schema to match on. *
  - Optional pageNumber?: number
    
    The page number to get. *
  - Optional pageSize?: number
    
    The number of schemas to get per page. *
  - Optional schemaType?: string
    
    Match only schemas with the given schema type *
  - Optional shared?: boolean
    
    Match only with shared or unshared schemas. *
  - 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<SchemasResponse>
- Defined in packages/ep-openapi-node/generated-src/services/SchemasService.ts:25

`Static` updateSchema

updateSchema(__namedParameters: {
    id: string;
    requestBody: SchemaObject;
    xContextId?: string;
}): CancelablePromise<SchemaResponse>
Update a schema Update a schema.

Token Permissions: [ schema:update:* ]

Returns
SchemaResponse Updated a schema. The newly saved schema is returned in the response body.

Throws
ApiError
Parameters
- __namedParameters: {
      id: string;
      requestBody: SchemaObject;
      xContextId?: string;
  }
  - id: string
    
    The ID of the schema. *
  - requestBody: SchemaObject
    
    The schema requires a name, an application domain, a schema type and a content type. *
  - Optional xContextId?: string
    
    Optional context id the request is running. *
Returns CancelablePromise<SchemaResponse>
- Defined in packages/ep-openapi-node/generated-src/services/SchemasService.ts:212

`Static` updateSchemaVersion

updateSchemaVersion(__namedParameters: {
    id: string;
    requestBody: SchemaVersion;
    xContextId?: string;
}): CancelablePromise<SchemaVersionResponse>
Update a schema version Use this API to update a schema version.

Token Permissions: [ schema:update:* ]

Returns
SchemaVersionResponse The schema version.

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

`Static` updateSchemaVersionState

updateSchemaVersionState(__namedParameters: {
    id: string;
    requestBody: VersionedObjectStateChangeRequest;
    xContextId?: string;
}): CancelablePromise<StateChangeRequestResponse>
Update the state of a schema version Use this API to update the state of a schema version.

Token Permissions: [ schema:update_state:* ]

Returns
StateChangeRequestResponse The updated state of the schema version.

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

Class SchemasService

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Returns SchemasService

Methods

Static createSchema

Returns

Throws

Parameters

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

requestBody: SchemaObject

Optional xContextId?: string

Returns CancelablePromise<SchemaResponse>

Static createSchemaVersion

Returns

Throws

Parameters

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

requestBody: SchemaVersion

Optional xContextId?: string

Returns CancelablePromise<SchemaVersionResponse>

Static deleteSchema

Returns

Throws

Parameters

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

id: string

Optional xContextId?: string

Returns CancelablePromise<void>

Static deleteSchemaVersion

Returns

Throws

Parameters

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

id: string

Optional xContextId?: string

Returns CancelablePromise<void>

Static getSchema

Returns

Throws

Parameters

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

id: string

Optional xContextId?: string

Returns CancelablePromise<SchemaResponse>

Static getSchemaVersion

Returns

Throws

Parameters

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

versionId: string

Optional xContextId?: string

Returns CancelablePromise<SchemaVersionResponse>

Static getSchemaVersions

Returns

Throws

Parameters

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

Optional customAttributes?: string

Optional ids?: string[]

Optional pageNumber?: number

Optional pageSize?: number

Optional schemaIds?: string[]

Optional xContextId?: string

Returns CancelablePromise<SchemaVersionsResponse>

Static getSchemas

Returns

Throws

Parameters

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

Optional applicationDomainId?: string

Optional applicationDomainIds?: string[]

Optional customAttributes?: string

Optional ids?: string[]

Optional name?: string

Optional pageNumber?: number

`Static` createSchema

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

`Optional` xContextId?: string

`Static` createSchemaVersion

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

`Optional` xContextId?: string

`Static` deleteSchema

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

`Optional` xContextId?: string

`Static` deleteSchemaVersion

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

`Optional` xContextId?: string

`Static` getSchema

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

`Optional` xContextId?: string

`Static` getSchemaVersion

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

`Optional` xContextId?: string

`Static` getSchemaVersions

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

`Optional` customAttributes?: string

`Optional` ids?: string[]

`Optional` pageNumber?: number

`Optional` pageSize?: number

`Optional` schemaIds?: string[]

`Optional` xContextId?: string

`Static` getSchemas

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

`Optional` applicationDomainId?: string

`Optional` applicationDomainIds?: string[]

`Optional` customAttributes?: string

`Optional` ids?: string[]

`Optional` name?: string

`Optional` pageNumber?: number

`Optional` pageSize?: number

`Optional` schemaType?: string

`Optional` shared?: boolean

`Optional` sort?: string

`Optional` xContextId?: string

`Static` updateSchema

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

`Optional` xContextId?: string

`Static` updateSchemaVersion

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

`Optional` xContextId?: string

`Static` updateSchemaVersionState

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

`Optional` xContextId?: string