Skip to content

CustomFormatApi.md

Latest commit

 

History

History
177 lines (91 loc) · 4.78 KB

CustomFormatApi.md

File metadata and controls

177 lines (91 loc) · 4.78 KB
Raw

\CustomFormatApi

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

Method HTTP request Description
create_custom_format POST /api/v1/customformat
delete_custom_format DELETE /api/v1/customformat/{id}
get_custom_format_by_id GET /api/v1/customformat/{id}
get_custom_format_schema GET /api/v1/customformat/schema
list_custom_format GET /api/v1/customformat
update_custom_format PUT /api/v1/customformat/{id}

create_custom_format

models::CustomFormatResource create_custom_format(custom_format_resource)

Parameters

Name Type Description Required Notes
custom_format_resource Option<CustomFormatResource>

Return type

models::CustomFormatResource

Authorization

apikey, X-Api-Key

HTTP request headers

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

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

delete_custom_format

delete_custom_format(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_custom_format_by_id

models::CustomFormatResource get_custom_format_by_id(id)

Parameters

Name Type Description Required Notes
id i32 [required]

Return type

models::CustomFormatResource

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]

get_custom_format_schema

get_custom_format_schema()

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]

list_custom_format

Vecmodels::CustomFormatResource list_custom_format()

Parameters

This endpoint does not need any parameter.

Return type

Vecmodels::CustomFormatResource

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]

update_custom_format

models::CustomFormatResource update_custom_format(id, custom_format_resource)

Parameters

Name Type Description Required Notes
id String [required]
custom_format_resource Option<CustomFormatResource>

Return type

models::CustomFormatResource

Authorization

apikey, X-Api-Key

HTTP request headers

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

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