Methods
# createMetaData(metadataConfig) → {Promise.<ResponseMessageEvent.<{metadata: IMetadata}>>}
Creates a new Metadata record.
Parameters:
| Name | Type | Description |
|---|---|---|
metadataConfig |
IMetadataCreateDto
|
The metadata configuration data required to create the metadata. |
A promise that resolves to the newly created metadata record.
Promise.<ResponseMessageEvent.<{metadata: IMetadata}>>
# deleteMetaData(metadataConfig) → {Promise.<ResponseMessageEvent.<undefined>>}
Deletes a metadata record.
Parameters:
| Name | Type | Description |
|---|---|---|
metadataConfig |
IMetadataDeleteDto
|
The metadata configuration. |
A promise that resolves when the metadata record has been deleted.
? A promise that resolves to the deleted metadata record.
Promise.<ResponseMessageEvent.<undefined>>
# retrieveAllMetaData(params) → {Promise.<ResponseMessageEvent.<{metadata: Array.<IMetadata>}>>}
Retrieves all metadata records.
Parameters:
| Name | Type | Description |
|---|---|---|
params |
GenericObjectType
|
Optional parameters for the query. |
A promise that resolves to an array of all metadata records.
Promise.<ResponseMessageEvent.<{metadata: Array.<IMetadata>}>>
# retrieveMetaData(metadataConfig) → {Promise.<ResponseMessageEvent.<{metadata: IMetadata}>>}
Retrieves a metadata record by its ID.
Parameters:
| Name | Type | Description |
|---|---|---|
metadataConfig |
IMetadataRetrieveDto
|
The metadata configuration containing its uid. |
A promise that resolves to the metadata record with the specified ID.
Promise.<ResponseMessageEvent.<{metadata: IMetadata}>>
# updateMetaData(metadataConfig) → {Promise.<ResponseMessageEvent.<{metadata: IMetadata}>>}
Updates a metadata record.
Parameters:
| Name | Type | Description |
|---|---|---|
metadataConfig |
IMetadataUpdateDto
|
The metadata configuration that needs to be updated. |
A promise that resolves when the metadata record that has been updated.
? A promise that resolves to the updated metadata record.
Promise.<ResponseMessageEvent.<{metadata: IMetadata}>>