Skip to content

Latest commit

 

History

History
241 lines (126 loc) · 7.14 KB

ImportListExclusionApi.md

File metadata and controls

241 lines (126 loc) · 7.14 KB

\ImportListExclusionApi

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

Method HTTP request Description
create_exclusions POST /api/v3/exclusions
create_exclusions_bulk POST /api/v3/exclusions/bulk
delete_exclusions DELETE /api/v3/exclusions/{id}
delete_exclusions_bulk DELETE /api/v3/exclusions/bulk
get_exclusions_by_id GET /api/v3/exclusions/{id}
get_exclusions_paged GET /api/v3/exclusions/paged
list_exclusions GET /api/v3/exclusions
update_exclusions PUT /api/v3/exclusions/{id}

create_exclusions

models::ImportListExclusionResource create_exclusions(import_list_exclusion_resource)

Parameters

Name Type Description Required Notes
import_list_exclusion_resource Option<ImportListExclusionResource>

Return type

models::ImportListExclusionResource

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]

create_exclusions_bulk

create_exclusions_bulk(import_list_exclusion_resource)

Parameters

Name Type Description Required Notes
import_list_exclusion_resource Option<Vecmodels::ImportListExclusionResource>

Return type

(empty response body)

Authorization

apikey, X-Api-Key

HTTP request headers

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

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

delete_exclusions

delete_exclusions(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_exclusions_bulk

delete_exclusions_bulk(import_list_exclusion_bulk_resource)

Parameters

Name Type Description Required Notes
import_list_exclusion_bulk_resource Option<ImportListExclusionBulkResource>

Return type

(empty response body)

Authorization

apikey, X-Api-Key

HTTP request headers

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

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

get_exclusions_by_id

models::ImportListExclusionResource get_exclusions_by_id(id)

Parameters

Name Type Description Required Notes
id i32 [required]

Return type

models::ImportListExclusionResource

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]

get_exclusions_paged

models::ImportListExclusionResourcePagingResource get_exclusions_paged(page, page_size, sort_key, sort_direction)

Parameters

Name Type Description Required Notes
page Option<i32> [default to 1]
page_size Option<i32> [default to 10]
sort_key Option<String>
sort_direction Option<SortDirection>

Return type

models::ImportListExclusionResourcePagingResource

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_exclusions

Vecmodels::ImportListExclusionResource list_exclusions()

Parameters

This endpoint does not need any parameter.

Return type

Vecmodels::ImportListExclusionResource

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_exclusions

models::ImportListExclusionResource update_exclusions(id, import_list_exclusion_resource)

Parameters

Name Type Description Required Notes
id String [required]
import_list_exclusion_resource Option<ImportListExclusionResource>

Return type

models::ImportListExclusionResource

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]