Class MetadataApi

Hierarchy

MetadataApi
- MetadataApi

Index

Constructors

Properties

basePath axios configuration

Methods

addMetadataSchemaToCollection getMetadataSchema updateMetadataSchemaByName

Constructors

constructor

new MetadataApi(configuration?, basePath?, axios?): MetadataApi
Parameters
- Optionalconfiguration: Configuration
- OptionalbasePath: string
- Optionalaxios: AxiosInstance
Returns MetadataApi
Inherited from imx.MetadataApi.constructor
- Defined in packages/internal/generated-clients/dist/imx/base.d.ts:43

Properties

`Protected`basePath

basePath: string

`Protected`axios

axios: AxiosInstance

`Protected`configuration

configuration: undefined | Configuration

Methods

addMetadataSchemaToCollection

addMetadataSchemaToCollection(requestParameters, options?): Promise<AxiosResponse<SuccessResponse, any>>
Add metadata schema to collection
Parameters
- requestParameters: MetadataApiAddMetadataSchemaToCollectionRequest
  Request parameters.
- Optionaloptions: AxiosRequestConfig<any>
  Override http request option.
Returns Promise<AxiosResponse<SuccessResponse, any>>
Summary
Add metadata schema to collection

Throws
Memberof
MetadataApi
Inherited from imx.MetadataApi.addMetadataSchemaToCollection
- Defined in packages/internal/generated-clients/dist/imx/domain/metadata-api.d.ts:226

getMetadataSchema

getMetadataSchema(requestParameters, options?): Promise<AxiosResponse<MetadataSchemaProperty[], any>>
Get collection metadata schema
Parameters
- requestParameters: MetadataApiGetMetadataSchemaRequest
  Request parameters.
- Optionaloptions: AxiosRequestConfig<any>
  Override http request option.
Returns Promise<AxiosResponse<MetadataSchemaProperty[], any>>
Summary
Get collection metadata schema

Throws
Memberof
MetadataApi
Inherited from imx.MetadataApi.getMetadataSchema
- Defined in packages/internal/generated-clients/dist/imx/domain/metadata-api.d.ts:235

updateMetadataSchemaByName

updateMetadataSchemaByName(requestParameters, options?): Promise<AxiosResponse<SuccessResponse, any>>
Update metadata schema by name
Parameters
- requestParameters: MetadataApiUpdateMetadataSchemaByNameRequest
  Request parameters.
- Optionaloptions: AxiosRequestConfig<any>
  Override http request option.
Returns Promise<AxiosResponse<SuccessResponse, any>>
Summary
Update metadata schema by name

Throws
Memberof
MetadataApi
Inherited from imx.MetadataApi.updateMetadataSchemaByName
- Defined in packages/internal/generated-clients/dist/imx/domain/metadata-api.d.ts:244