Skip to content

Auto generated schema based UPDATE BY ID 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: PUT

Update single field of single record by id

URL 

/api/schema/user-path/instance/database/table/update-by-id/1
Request Payload 
{
    "pincode": 382330
}

Update multiple fields of a single record by id

URL 

/api/schema/user-path/instance/database/table/update-by-id/1
Request Payload 
{
    "first_name": "Gaetano",
    "last_name": "Jesse",
    "last_update": "2022-11-16T05:02:09.877Z",
    "pincode": 582550,
    "isActive": 0
}

Override primary key

URL 

/api/schema/user-path/instance/database/table/update-by-id/Bob/first_name
Request Payload 
{
    "pincode": 382330
}

Override the primary key and update the name field provided as the primary key

URL 

/api/schema/user-path/instance/database/table/update-by-id/Mallory/first_name
Request Payload 
{
    "first_name": "Alice",
    "last_name": "Jo",
    "last_update": "2006-02-14T23:04:33.000Z",
    "pincode": 382480,
    "isActive": 1
}

Select: Update a single record by id, and get selected data in response.

URL 

/api/schema/user-path/instance/database/table/update-by-id/1?select=first_name,last_name
Request Payload 
{
    "pincode": 382330
}

Deep data

  • It will return documents/rows from multiple table combinations.

URL 

/api/schema/user-path/instance/database/table/update-by-id/1?deep=[{s_key:'customer_id,t_col:'products',t_key:'owner_id'}]
Request Payload 
{
    "pincode": 382330
}
Here,

s_key = Source table field
t_col = Target table collection/table name
t_key = Target table field
  • also use multiple query params [skip, limit, sort, find, etc...] in a single deep query.

upsert : either update or insert

URL 

/api/schema/user-path/instance/database/table/update-by-id/999?upsert=true
- Upsert working like either [customer_id equals to "999" exist then update] or [insert the record with customer_id equals "999"] - Upsert is not working in sql_server.

Request Payload 

{
    "first_name": "Daphney",
    "last_name": "Sonia",
    "last_update": "2022-11-16T10:42:44.713Z",
    "pincode": 980220,
    "isActive": 0
}

returnDocument: before/after

  • 'returnDocument=before' get a response which going to be updated.
  • 'returnDocument=after' get an updated response.
  • ReturnDocument affects only on response.

URL 

/api/schema/user-path/instance/database/table/update-by-id/999?returnDocument=before
Request Payload 
{
    "first_name": "Daphney",
    "last_name": "Sonia",
    "last_update": "2022-11-16T10:42:44.713Z",
    "pincode": 980220,
    "isActive": 0
}

Supported headers

Header Description
x-am-response-case It will change the response keys text as requested case. 
"x-am-response-case": "camelCase"
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. 
"x-am-response-object-type": "make_flat"
no_action | make_flat
x-am-meta To get the meta-data of requested API. 
"x-am-meta": "true"
false | true
x-am-secret Place secret id from API Maker. 
"x-am-secret": "6381b80359bdbd3a87c9abd5"
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-internationalization": "HINDI"
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-run-in-sandbox": "0"
x-am-content-type-response We can provide response type in request header. As provided header value we can expect the response type. 
"x-am-content-type-response": "application/json"
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. 
"x-am-cache-control": "reset_cache"
no_action | reset_cache
x-am-get-encrypted-data Encrypt response data and get in to the response. 
"x-am-get-encrypted-data": "get_data_and_encryption"
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-authorization": "eyJhbGciOiJIUzI1NiIsdlRrblJlcS"
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-am-user-authorization": "eyJhbGciOiJIpc1BydlRrblJlcS"
x-aws-authorization Provide AWS Cognito token in request header 'x-aws-authorization', if required. 
"x-aws-authorization": "eyJhbGciOiJIUc1BdlRrlJlcS"
x-google-authorization Provide Google user token in request header 'x-google-authorization', if required. 
"x-google-authorization": "eyJhbGceyJpc1BdlRrlJlcS"
x-azure-authorization Provide Azure active directory token in request header 'x-azure-authorization', if required. 
"x-azure-authorization": "eyJhbGciOiJIUzI1NiIJpc1BdlRrlJlcS"
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-no-compression": "true"
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-sandbox-timeout": "13000"  // milliseconds
x-am-encrypted-payload When user sent encrypted payload, user must have to sent "x-am-encrypted-payload:true". 
"x-am-encrypted-payload": "true"