Skip to content

ImportListApi.md

Latest commit

 

History

History
323 lines (168 loc) · 8.87 KB

ImportListApi.md

File metadata and controls

323 lines (168 loc) · 8.87 KB

\ImportListApi

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

Method HTTP request Description
create_import_list POST /api/v3/importlist
create_import_list_action_by_name POST /api/v3/importlist/action/{name}
delete_import_list DELETE /api/v3/importlist/{id}
delete_import_list_bulk DELETE /api/v3/importlist/bulk
get_import_list_by_id GET /api/v3/importlist/{id}
list_import_list GET /api/v3/importlist
list_import_list_schema GET /api/v3/importlist/schema
put_import_list_bulk PUT /api/v3/importlist/bulk
test_import_list POST /api/v3/importlist/test
testall_import_list POST /api/v3/importlist/testall
update_import_list PUT /api/v3/importlist/{id}

create_import_list

models::ImportListResource create_import_list(force_save, import_list_resource)

Parameters

Name Type Description Required Notes
force_save Option<bool> [default to false]
import_list_resource Option<ImportListResource>

Return type

models::ImportListResource

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_import_list_action_by_name

create_import_list_action_by_name(name, import_list_resource)

Parameters

Name Type Description Required Notes
name String [required]
import_list_resource Option<ImportListResource>

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_import_list

delete_import_list(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_import_list_bulk

delete_import_list_bulk(import_list_bulk_resource)

Parameters

Name Type Description Required Notes
import_list_bulk_resource Option<ImportListBulkResource>

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_import_list_by_id

models::ImportListResource get_import_list_by_id(id)

Parameters

Name Type Description Required Notes
id i32 [required]

Return type

models::ImportListResource

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_import_list

Vecmodels::ImportListResource list_import_list()

Parameters

This endpoint does not need any parameter.

Return type

Vecmodels::ImportListResource

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_import_list_schema

Vecmodels::ImportListResource list_import_list_schema()

Parameters

This endpoint does not need any parameter.

Return type

Vecmodels::ImportListResource

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_import_list_bulk

models::ImportListResource put_import_list_bulk(import_list_bulk_resource)

Parameters

Name Type Description Required Notes
import_list_bulk_resource Option<ImportListBulkResource>

Return type

models::ImportListResource

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_import_list

test_import_list(force_test, import_list_resource)

Parameters

Name Type Description Required Notes
force_test Option<bool> [default to false]
import_list_resource Option<ImportListResource>

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_import_list

testall_import_list()

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_import_list

models::ImportListResource update_import_list(id, force_save, import_list_resource)

Parameters

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

Return type

models::ImportListResource

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]