Skip to content

DownloadClientApi.md

Latest commit

 

History

History
323 lines (168 loc) · 9.3 KB

DownloadClientApi.md

File metadata and controls

323 lines (168 loc) · 9.3 KB

\DownloadClientApi

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

Method HTTP request Description
create_download_client POST /api/v1/downloadclient
create_download_client_action_by_name POST /api/v1/downloadclient/action/{name}
delete_download_client DELETE /api/v1/downloadclient/{id}
delete_download_client_bulk DELETE /api/v1/downloadclient/bulk
get_download_client_by_id GET /api/v1/downloadclient/{id}
list_download_client GET /api/v1/downloadclient
list_download_client_schema GET /api/v1/downloadclient/schema
put_download_client_bulk PUT /api/v1/downloadclient/bulk
test_download_client POST /api/v1/downloadclient/test
testall_download_client POST /api/v1/downloadclient/testall
update_download_client PUT /api/v1/downloadclient/{id}

create_download_client

models::DownloadClientResource create_download_client(force_save, download_client_resource)

Parameters

Name Type Description Required Notes
force_save Option<bool> [default to false]
download_client_resource Option<DownloadClientResource>

Return type

models::DownloadClientResource

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_download_client_action_by_name

create_download_client_action_by_name(name, download_client_resource)

Parameters

Name Type Description Required Notes
name String [required]
download_client_resource Option<DownloadClientResource>

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_download_client

delete_download_client(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]

delete_download_client_bulk

delete_download_client_bulk(download_client_bulk_resource)

Parameters

Name Type Description Required Notes
download_client_bulk_resource Option<DownloadClientBulkResource>

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]

get_download_client_by_id

models::DownloadClientResource get_download_client_by_id(id)

Parameters

Name Type Description Required Notes
id i32 [required]

Return type

models::DownloadClientResource

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_download_client

Vecmodels::DownloadClientResource list_download_client()

Parameters

This endpoint does not need any parameter.

Return type

Vecmodels::DownloadClientResource

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_download_client_schema

Vecmodels::DownloadClientResource list_download_client_schema()

Parameters

This endpoint does not need any parameter.

Return type

Vecmodels::DownloadClientResource

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]

put_download_client_bulk

models::DownloadClientResource put_download_client_bulk(download_client_bulk_resource)

Parameters

Name Type Description Required Notes
download_client_bulk_resource Option<DownloadClientBulkResource>

Return type

models::DownloadClientResource

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]

test_download_client

test_download_client(force_test, download_client_resource)

Parameters

Name Type Description Required Notes
force_test Option<bool> [default to false]
download_client_resource Option<DownloadClientResource>

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_download_client

testall_download_client()

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_download_client

models::DownloadClientResource update_download_client(id, force_save, download_client_resource)

Parameters

Name Type Description Required Notes
id String [required]
force_save Option<bool> [default to false]
download_client_resource Option<DownloadClientResource>

Return type

models::DownloadClientResource

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]