Get all data

firstName	lastName	Age	isMarried	status
Jigar	Goswami	32	true	A
Mayur	Patel	32	true	A
Sanket	Patel	30	false	A
Sanket	Patel	30	false	A

This API used to get all data using query params as filter.

Predefined keys:

find

To find exact value we can use find key. In Body, you have to send it with JSON format.

Generated url:

?find={first_name:"NICK",phone:"1123456789"}

sort

Fetch sorted data using sort key.
We can give it '-' to sort descending order.

?sort=first_name
?sort=-phone

limit

Set limits of the response data length using the limit key.

?limit=2

skip

It skips the data length by given number.

?skip=1&limit=2

select

To get selected values in the response, give key name in the select key. Add multiple key comma separate.
We can add '-' to do not get that keys in the response.

?select=phone,first_name
?select=-phone,-status

deep

deep - get deep data. It supports s_key, t_col, skip, t_key, isMultiple, select, limit, sort, find. s_key - Source key - define source table key name which have relation with target collection.
t_col - Target collection - define target collection name.
t_key - Target key - target collection's key which have relation with the source key.
skip - Skip given count data.
isMultiple - Get multiple matching relation data.
select - If we add '-' before any key name it will not get in response.
limit - Get only given number data.
sort - Sorting with given key name.
find - To find particular we can use it.

{
  "deep": [
    {
      "s_key": "customer_id",
      "t_col": "products",
      "t_key": "owner_id",
      "skip": 1,
      "isMultiple": true,
      "select": "-status",
      "limit": 5,
      "sort": "name",
      "find": {
        "category_id": {
          "$in": [
            56572,
            89355
          ]
        }
      }
    }
  ]
}

Generated url:

?deep=[{"s_key":"customer_id","t_col":"products","t_key":"owner_id","skip":1,"isMultiple":true,"select":"-status","limit":5,"sort":"name","find":{"category_id":{"$in":[56572,89355]}}}]

Operators

Equal, key=val

Request send with 'key=value' pair to filter.
Generated url:

?customer_id=3

Greater than, key>val

Request send with 'key>value' pair to filter. The response contains greater values only.
Postgres database will give error if we ask for float number, if the database column type is integer.
Generated url:

?customer_id>3
?price>3.3
?first_name>ED

Less than, key<val

Request send with 'key<value' pair to filter. The response contains less than values only.
Generated url:

?customer_id<3

Greater than equal, key>=val

Request send with 'key>=value' pair to filter. The response contains greater and equals values only.
Generated url:

?customer_id>=3

Less than equal, key<=val

Request send with 'key<=value' pair to filter. The response contains less than and equals values only.
Generated url:

?customer_id<=2

Not equal, key!=val

Request send with 'key!=value' pair to filter. The response do not contain equals values only.
Generated url:

?customer_id!=2

Not in, key!=val,val

Request send with 'key!=value,value' pair to filter. The response do not contain equals values only.
Generated url:

?customer_id!=2,3

Request Headers:

Request header contains the response content type. Get response based on requested type.

x-am-content-type-response:

application/json

Get response in json format.

x-am-content-type-response: application/json

text/xml

Get response in XML format.

x-am-content-type-response: text/xml

text/yaml

Get response in YAML format.

x-am-content-type-response: text/yaml

x-am-response-case:

Request header contains the response keys case. Get response keys based on requested case.

camelCase

Get response keys in camelCase.

x-am-response-case: camelCase

capitalCase

Get response keys in capitalCase.

x-am-response-case: capitalCase

constantCase

Get response keys in constantCase.

x-am-response-case: constantCase

dotCase

Get response keys in dotCase.

x-am-response-case: dotCase

headerCase

Get response keys in headerCase.

x-am-response-case: headerCase

noCase

Get response keys in noCase.

x-am-response-case: noCase

paramCase

Get response keys in paramCase.

x-am-response-case: paramCase

pascalCase

Get response keys in pascalCase.

x-am-response-case: pascalCase

pathCase

Get response keys in pathCase.

x-am-response-case: pathCase

sentenceCase

Get response keys in sentenceCase.

x-am-response-case: sentenceCase

snakeCase

Get response keys in snakeCase.

x-am-response-case: snakeCase

x-am-response-object-type:

Request header contains the response keys case. Get response keys based on requested case.

make_flat

Get deep response in flat object.

x-am-response-object-type: make_flat

x-am-get-encrypted-data:

Request header contains the response keys case. Get response keys based on requested case.

get_only_encryption

Get response data in one encrypted string.

x-am-get-encrypted-data: get_only_encryption

get_data_and_encryption

Get response data and get same data encrypted in string.

x-am-get-encrypted-data: get_data_and_encryption

x-am-cache-control:

Request header contains cache should be reset or not. Get response from cache or database depends upon request.
By default, try to get from the cache.

reset_cache

It is use for getting data from the API call. It does not get data from cache memory.

x-am-cache-control: reset_cache