MetadataApi.md

\MetadataApi

All URIs are relative to http://localhost:7878

Method	HTTP request	Description
create_metadata	POST /api/v3/metadata
create_metadata_action_by_name	POST /api/v3/metadata/action/{name}
delete_metadata	DELETE /api/v3/metadata/{id}
get_metadata_by_id	GET /api/v3/metadata/{id}
list_metadata	GET /api/v3/metadata
list_metadata_schema	GET /api/v3/metadata/schema
test_metadata	POST /api/v3/metadata/test
testall_metadata	POST /api/v3/metadata/testall
update_metadata	PUT /api/v3/metadata/{id}

create_metadata

models::MetadataResource create_metadata(force_save, metadata_resource)

Parameters

Name	Type	Description	Required	Notes
force_save	Option<bool>			[default to false]
metadata_resource	Option<MetadataResource>

Return type

models::MetadataResource

Authorization

apikey, X-Api-Key

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_metadata_action_by_name

create_metadata_action_by_name(name, metadata_resource)

Parameters

Name	Type	Description	Required	Notes
name	String		[required]
metadata_resource	Option<MetadataResource>

Return type

(empty response body)

Authorization

apikey, X-Api-Key

HTTP request headers

• Content-Type: application/json
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_metadata

delete_metadata(id)

Parameters

Name	Type	Description	Required	Notes
id	i32		[required]

Return type

(empty response body)

Authorization

apikey, X-Api-Key

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_metadata_by_id

models::MetadataResource get_metadata_by_id(id)

Parameters

Name	Type	Description	Required	Notes
id	i32		[required]

Return type

models::MetadataResource

Authorization

apikey, X-Api-Key

HTTP request headers

• Content-Type: Not defined
• Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_metadata

Vecmodels::MetadataResource list_metadata()

Parameters

This endpoint does not need any parameter.

Return type

Vecmodels::MetadataResource

Authorization

apikey, X-Api-Key

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_metadata_schema

Vecmodels::MetadataResource list_metadata_schema()

Parameters

This endpoint does not need any parameter.

Return type

Vecmodels::MetadataResource

Authorization

apikey, X-Api-Key

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

test_metadata

test_metadata(force_test, metadata_resource)

Parameters

Name	Type	Description	Required	Notes
force_test	Option<bool>			[default to false]
metadata_resource	Option<MetadataResource>

Return type

(empty response body)

Authorization

apikey, X-Api-Key

HTTP request headers

• Content-Type: application/json
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

testall_metadata

testall_metadata()

Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

apikey, X-Api-Key

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_metadata

models::MetadataResource update_metadata(id, force_save, metadata_resource)

Parameters

Name	Type	Description	Required	Notes
id	i32		[required]
force_save	Option<bool>			[default to false]
metadata_resource	Option<MetadataResource>

Return type

models::MetadataResource

Authorization

apikey, X-Api-Key

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]