Skip to content

DictionaryItemApi.md

Latest commit

 

History

History
283 lines (181 loc) · 9.21 KB

DictionaryItemApi.md

File metadata and controls

283 lines (181 loc) · 9.21 KB

DictionaryItemApi

Note

All URIs are relative to https://api.fastly.com

Method HTTP request Description
bulk_update_dictionary_item PATCH /service/{service_id}/dictionary/{dictionary_id}/items Update multiple entries in a dictionary
create_dictionary_item POST /service/{service_id}/dictionary/{dictionary_id}/item Create an entry in a dictionary
delete_dictionary_item DELETE /service/{service_id}/dictionary/{dictionary_id}/item/{dictionary_item_key} Delete an item from a dictionary
get_dictionary_item GET /service/{service_id}/dictionary/{dictionary_id}/item/{dictionary_item_key} Get an item from a dictionary
list_dictionary_items GET /service/{service_id}/dictionary/{dictionary_id}/items List items in a dictionary
update_dictionary_item PATCH /service/{service_id}/dictionary/{dictionary_id}/item/{dictionary_item_key} Update an entry in a dictionary
upsert_dictionary_item PUT /service/{service_id}/dictionary/{dictionary_id}/item/{dictionary_item_key} Insert or update an entry in a dictionary

bulk_update_dictionary_item

Update multiple items in the same dictionary. For faster updates to your service, group your changes into large batches. The maximum batch size is 1000 items. Contact support to discuss raising this limit.

let cfg = &Configuration::default();
let params = BulkUpdateDictionaryItemParams {
    // parameters
};
bulk_update_dictionary_item(cfg, params)

Parameters

Name Type Description Required Notes
service_id String Alphanumeric string identifying the service. [required]
dictionary_id String Alphanumeric string identifying a Dictionary. [required]
bulk_update_dictionary_list_request Option<BulkUpdateDictionaryListRequest>

Return type

crate::models::InlineResponse200

Authorization

token

HTTP request headers

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

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

create_dictionary_item

Create DictionaryItem given service, dictionary ID, item key, and item value.

let cfg = &Configuration::default();
let params = CreateDictionaryItemParams {
    // parameters
};
create_dictionary_item(cfg, params)

Parameters

Name Type Description Required Notes
service_id String Alphanumeric string identifying the service. [required]
dictionary_id String Alphanumeric string identifying a Dictionary. [required]
item_key Option<String> Item key, maximum 256 characters.
item_value Option<String> Item value, maximum 8000 characters.

Return type

crate::models::DictionaryItemResponse

Authorization

token

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

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

delete_dictionary_item

Delete DictionaryItem given service, dictionary ID, and item key.

let cfg = &Configuration::default();
let params = DeleteDictionaryItemParams {
    // parameters
};
delete_dictionary_item(cfg, params)

Parameters

Name Type Description Required Notes
service_id String Alphanumeric string identifying the service. [required]
dictionary_id String Alphanumeric string identifying a Dictionary. [required]
dictionary_item_key String Item key, maximum 256 characters. [required]

Return type

crate::models::InlineResponse200

Authorization

token

HTTP request headers

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

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

get_dictionary_item

Retrieve a single DictionaryItem given service, dictionary ID and item key.

let cfg = &Configuration::default();
let params = GetDictionaryItemParams {
    // parameters
};
get_dictionary_item(cfg, params)

Parameters

Name Type Description Required Notes
service_id String Alphanumeric string identifying the service. [required]
dictionary_id String Alphanumeric string identifying a Dictionary. [required]
dictionary_item_key String Item key, maximum 256 characters. [required]

Return type

crate::models::DictionaryItemResponse

Authorization

token

HTTP request headers

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

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

list_dictionary_items

List of DictionaryItems given service and dictionary ID.

let cfg = &Configuration::default();
let params = ListDictionaryItemsParams {
    // parameters
};
list_dictionary_items(cfg, params)

Parameters

Name Type Description Required Notes
service_id String Alphanumeric string identifying the service. [required]
dictionary_id String Alphanumeric string identifying a Dictionary. [required]
page Option<i32> Current page.
per_page Option<i32> Number of records per page. [default to 100]
sort Option<String> Field on which to sort. [default to created]
direction Option<String> Direction in which to sort results. [default to ascend]

Return type

Vec<crate::models::DictionaryItemResponse>

Authorization

token

HTTP request headers

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

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

update_dictionary_item

Update DictionaryItem given service, dictionary ID, item key, and item value.

let cfg = &Configuration::default();
let params = UpdateDictionaryItemParams {
    // parameters
};
update_dictionary_item(cfg, params)

Parameters

Name Type Description Required Notes
service_id String Alphanumeric string identifying the service. [required]
dictionary_id String Alphanumeric string identifying a Dictionary. [required]
dictionary_item_key String Item key, maximum 256 characters. [required]
item_key Option<String> Item key, maximum 256 characters.
item_value Option<String> Item value, maximum 8000 characters.

Return type

crate::models::DictionaryItemResponse

Authorization

token

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

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

upsert_dictionary_item

Upsert DictionaryItem given service, dictionary ID, item key, and item value.

let cfg = &Configuration::default();
let params = UpsertDictionaryItemParams {
    // parameters
};
upsert_dictionary_item(cfg, params)

Parameters

Name Type Description Required Notes
service_id String Alphanumeric string identifying the service. [required]
dictionary_id String Alphanumeric string identifying a Dictionary. [required]
dictionary_item_key String Item key, maximum 256 characters. [required]
item_key Option<String> Item key, maximum 256 characters.
item_value Option<String> Item value, maximum 8000 characters.

Return type

crate::models::DictionaryItemResponse

Authorization

token

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

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