Auto generated schema based MASTER SAVE API
Table structure
| customer_id | first_name | last_name | last_update | pincode | isActive |
|---|---|---|---|---|---|
| 1 | Bob | lin | 2022-11-14 04: 34: 58 | 382345 | 1 |
| 2 | Alice | Page | 2022-10-15 02: 10: 40 | 382346 | 1 |
| 3 | Mallory | Brown | 2022-09-13 03: 44: 05 | 382347 | 1 |
| 4 | Eve | Mathly | 2022-11-12 01: 59: 33 | 382348 | 1 |
| 5 | Eve | Page | 2022-11-12 01: 59: 33 | 382349 | 1 |
Request Method: POST
Save single record
URL
Request Payload
Save multiple record
URL
Request Payload
Save record with primary key field
- Here customer_id is primary key field.
URL
Request Payload
Save multiple record with primary key or without primary key in single payload
- In the below example, we save and update at the same time. The customer_id=2 data is available in the database table, so it will update and another object will be saved.
- Here customer_id is a primary key field.
URL
Request Payload
[
{
"customer_id": 2,
"first_name": "Eve",
"last_name": "Page"
},
{
"first_name": "Bob",
"last_name": "Marley"
}
]
Nested Save Example
City table
| id | state_id | city_name |
|---|---|---|
| 101 | 201 | Ahmedabad |
| 102 | 201 | Surat |
| 103 | 202 | Evanston |
| 104 | 202 | Itasca |
| 105 | 203 | Albany |
| 106 | 203 | Buffalo |
State table
| id | country_id | state_name |
|---|---|---|
| 201 | 301 | Gujarat |
| 202 | 301 | Delhi |
| 203 | 302 | Chicago |
| 204 | 302 | New York |
Country table
| id | country_name |
|---|---|
| 301 | India |
| 302 | USA |
Save Nested : save nested tables data here we save records in three table using the single payload
- It will save data in three tables with single API call
URL
Request Payload
{
"city_name": "Wembley",
"state_id": {
"state_name": "London",
"country_id": {
"country_name": "UK"
}
}
}
Save multiple records in multiple tables with single API call
URL
Request Payload
[
{
"city_name": "Panaji",
"state_id": {
"state_name": "Goa",
"country_id": 301
}
},
{
"state_id": 201,
"city_name": "Bhavnagar"
}
]
Deep: Get nested data in response
- Add "?deep=column_name" as query params in the URl and you will get the deep data.
- Check the schema in which you need to add the instance, database, collection, and column name in the column in which you want to get nested data.
- Learn more about deep.
URL
Response
{
"success": true,
"statusCode": 201,
"data": {
"city_name": "Panaji",
"state_id": {
"state_name": "Goa",
"country_id": 301
}
}
}
- Get multi-level nested data using query params as shown below.
- You can get nested data as much as you want.
URL
Response
{
"success": true,
"statusCode": 201,
"data": {
"city_name": "Panaji",
"state_id": {
"state_name": "Goa",
"country_id": {
"country_name": "INDIA",
"id": 301
}
}
}
}
Select: Get selected columns in response
- Just add the columns name as query params, and you will get that key value only in the response.
URL
Response
Revert data : if nested save fail, revert all saved/updated data.
- Perform save in Country, State & City. If the 'State' table payload does not have a valid key-value, it will revert the Country's saved data.
- Here 'state_namee' field is written wrong in the given payload.
URL
Request Payload
{
"city_name": "Wembley",
"state_id": {
"state_namee": "London",
"country_id": {
"country_name": "UK"
}
}
}
Supported headers
| Header | Description |
|---|---|
| x-am-response-case | It will change the response keys text as requested case. noChange | camelCase | capitalCase | constantCase | dotCase | headerCase | noCase | paramCase | pascalCase | pathCase | sentenceCase | snakeCase |
| x-am-response-object-type | To get flat response we use this request header. no_action | make_flat |
| x-am-meta | To get the meta-data of requested API. false | true |
| x-am-secret | Place secret id from API Maker. |
| x-am-internationalization |
We can get backend error messages in any user language and directly show them to the user in UI, so the user can take appropriate actions.
Provide saved internationalization name in request header. |
| x-am-run-in-sandbox | System will try to run requests in maximum provided sandbox, so if 1 provided every request will run in one sandbox, even if we have multiple sandbox with multiple API Maker instances. |
| x-am-content-type-response | We can provide response type in request header. As provided header value we can expect the response type. application/json | text/xml | text/yaml |
| x-am-cache-control | To reset the cache of the requested API manually and get fresh data, we can use 'x-am-cache-control' request header. no_action | reset_cache |
| x-am-get-encrypted-data | Encrypt response data and get in to the response. no_encryption | get_only_encryption | get_data_and_encryption |
| x-am-authorization | Provide token of API user in "x-am-authorization" header which will be generated from API Users inside API Maker. |
| x-am-user-authorization | User token should be provided in 'x-am-user-authorization' header which will be generated based on some database user if required. |
| x-aws-authorization | Provide AWS Cognito token in request header 'x-aws-authorization', if required. |
| x-google-authorization | Provide Google user token in request header 'x-google-authorization', if required. |
| x-azure-authorization | Provide Azure active directory token in request header 'x-azure-authorization', if required. |
| x-no-compression | If user do not send 'x-no-compression' in request header, and response characters are more than value of "maxCharsResToCache" than the response will be compressed. |
| x-am-sandbox-timeout | If any API did not give a response within given time, the sandbox will break and give a proper error message in the response. |
| x-am-encrypted-payload | When user sent encrypted payload, user must have to sent "x-am-encrypted-payload:true". |