How to: Implement Custom Code in Entity Service

7min

Implementing Pre-Configured Custom Code
The pre-configured Custom Code URL is available for each API that supports Custom Code. The Custom Code will be registered and configured for a type - Like entityTypePluralName.
Developers can configure the Custom Code for - Create Instance, Update Instance, and Apply Event.
Implementing Custom Code in the Request Body
To dynamically modify the Custom Code config for each API call, we've added two attributes﻿.
It can be used for creating, updating, and applying requests.
Custom Code Fields
To add custom code in the Entity﻿ add the following values in the request body:
Name
Type
Description
url
string
Request URL for the Custom Code API call.
requestHeader
object
Default headers for Custom Code API call.
method
string
HTTP method - Type of API request for custom code (POST/PUT/GET)
wait
boolean
Wait for the response from the API call
acceptableStatusCodes
array
Acceptable status codes.
raiseErrorOnStatusMismatch
boolean
Raise an error if the status code returned doesn’t match acceptableStatusCodes.
methodName**
string
Type of action (for create, update, or apply) and onRequest or onError
📘 methodNames allowed are - create:OnRequest, create:OnError, update:OnRequest, update:OnError, apply_event:OnRequest, apply_event:OnError
Here is a sample payload of Custom Code with methodName apply_event:OnRequest :
JSON
{  
    "url": "https://www.test.com",  
    "requestBody": {},  
    "requestHeader": {  
        "X-COREOS-ACCESS": "{{token}}",  
        "X-COREOS-REQUEST-ID": "{{request_id}}",  
        "X-COREOS-TID": "{{tenant_id}}",  
        "X-COREOS-USERINFO": {  
            "id": "Test1",  
            "name": "CustomCode"  
        }  
    },  
    "method": "GET",  
    "wait": true,  
    "methodName": "apply_event:onRequest"  
}
{  
    "url": "https://www.test.com",  
    "requestBody": {},  
    "requestHeader": {  
        "X-COREOS-ACCESS": "{{token}}",  
        "X-COREOS-REQUEST-ID": "{{request_id}}",  
        "X-COREOS-TID": "{{tenant_id}}",  
        "X-COREOS-USERINFO": {  
            "id": "Test1",  
            "name": "CustomCode"  
        }  
    },  
    "method": "GET",  
    "wait": true,  
    "methodName": "apply_event:onRequest"  
}
﻿
Expected Response From Custom Code
Data is expected in response to the Custom Code with the existing payload in the data fields.
JSON
{  
  data: {  
	...  
  }  
}
{  
  data: {  
	...  
  }  
}
﻿
Data Formation from Custom Code Response
The fields returned from Custom Code inside the data field are replaced with the existing payload as shown below.
The Payload in Request Body
JSON
{
    "uniqueCode": "code1",
    "name": "vehicle",
    "owner": "delhivery",
    "properties": {
        "count": 10,
        "color": "blue"
    },
    "callback": {
        "url": "http://www.examplecallback.com"
    }
}
{
    "uniqueCode": "code1",
    "name": "vehicle",
    "owner": "delhivery",
    "properties": {
        "count": 10,
        "color": "blue"
    },
    "callback": {
        "url": "http://www.examplecallback.com"
    }
}
﻿
Payload from Custom Code returned
JSON
{
  "properties": {
    "count": 120
  },
  "callback": {
    "url": "https://delhivery.test.com/test",
    "meta": {
        "source": "coreos"
     }
  }
}


{
  "properties": {
    "count": 120
  },
  "callback": {
    "url": "https://delhivery.test.com/test",
    "meta": {
        "source": "coreos"
     }
  }
}

﻿
Final Payload that is used to register an instance
JSON
{
    "uniqueCode": "code1",
    "name": "vehicle",
    "owner": "delhivery",
    "properties": {
        "count": 120
    },
    "callback": {
        "url": "https://delhivery.test.com/test",
    "meta": {
        "source": "coreos"
      }
    }
}
{
    "uniqueCode": "code1",
    "name": "vehicle",
    "owner": "delhivery",
    "properties": {
        "count": 120
    },
    "callback": {
        "url": "https://delhivery.test.com/test",
    "meta": {
        "source": "coreos"
      }
    }
}
﻿
Restriction on Fields in Custom Code Response
For different APIs in Custom Code, there are few restrictions as to what Data keys are not acceptable for particular API types. We have provided the list below for the developers to know more.
API Type
Values not accepted in Data keys
Values accepted in Data keys
Create Instance
uniqueCodeOwnerappIdentityTypePluralName
PropertiesCallbackCategorySubCategory
Update Instance
uniqueCodeOwnerappIdentityTypePluralName
PropertiesCallback
Apply Event
uniqueCodeOwnerappIdentityTypePluralName
eventCodereasonCode
﻿

Name	Type	Description
url	string	Request URL for the Custom Code API call.
requestHeader	object	Default headers for Custom Code API call.
method	string	HTTP method - Type of API request for custom code (POST/PUT/GET)
wait	boolean	Wait for the response from the API call
acceptableStatusCodes	array	Acceptable status codes.
raiseErrorOnStatusMismatch	boolean	Raise an error if the status code returned doesn’t match acceptableStatusCodes.
methodName**	string	Type of action (for create, update, or apply) and onRequest or onError

API Type	Values not accepted in Data keys	Values accepted in Data keys
Create Instance	uniqueCodeOwnerappIdentityTypePluralName	PropertiesCallbackCategorySubCategory
Update Instance	uniqueCodeOwnerappIdentityTypePluralName	PropertiesCallback
Apply Event	uniqueCodeOwnerappIdentityTypePluralName	eventCodereasonCode

Updated 16 Aug 2023

Did this page help you?

How to: Apply Event to an Entity

How To: Create & Update Entities In Batch