Get Specific Key-Values¶

Description¶

This operation retrieves specific key-value pairs from a map.

Method¶

POST

Endpoint URL¶

Important

Make sure to replace xxxx in the domain name in the request specification below to the one assigned to your application.

https://xxxx.backendless.app/api/hive/[hive-name]/map/[key]

where:

Argument	Description
`[hive-name]`	Name of a hive where the operation is performed.
`[key]`	Key name identifying a map.

Request Headers¶

Content-Type:application/json

where:

Argument	Description
`Content-Type`	Must be set to `application/json`. This header is mandatory.

Request Body¶

The request body must be a JSON array containing key names. Each individual key must be a string value:

["key1", "888", "key2" ...]

Response Body¶

A JSON object containing key-value pairs retrieved from the map. Returns an empty JSON object if the specified keys do not exist.

Example¶

The example below retrieves key-value pairs specified by key names: "Oranges" and "Apples" from the fruits map.

curl --location --request POST "https://xxxx.backendless.app/api/hive/groceryStore/map/fruits" \--header 'Content-Type: application/json' \--data-raw '["Oranges", "Apples"]'

where:

Argument	Description
`groceryStore`	Name of a hive where the operation is performed.
`fruits`	Key name identifying a map.

Response Example

{  
    "Oranges": 0.99,  
    "Apples": 1.19  
}

Codeless Reference¶

map_api_get_specific_key_values

where:

Argument	Description
`hive name`	Name of a hive where the operation is performed.
`key name`	Key name identifying a map.
`object keys`	A list of key names identifying key-value pairs.

Returns an object containing key-value pairs retrieved from the map.

Consider the following Map storage:
map_apI_example_map_store

The example below retrieves two key-value pairs for the "Oranges" and "Apples" keys from the "fruits" map.

map_api_example_get_specific_key_values

The logic produces the following output:

get-specific-key-values-result