SmartObject OData API v4 endpoints

The example in this topic uses a simple SmartObject called EmployeeSample with six properties and default methods. Use the Designer to create the following SmartObject, and execute the Create method to enter some data.

Property Name	Data Type
ID	Autonumber
FirstName	String
LastName	String
HireDate	DateTime
DepartmentCode	Number
Joblevel	String

The default methods are:

• GetList
• Create
• Delete
• Save
• Load

Use the OData URL to return a list of entities (SmartObjects available to the OData API):

https://{{base_URL}}/

Adding $metadata to the URL returns formatted XML which is easier to read than the raw JSON. You can only use the $metadata parameter on the OData base URL, not on any other endpoint:

https://{{base_URL}}/$metadata

At the bottom of the returned XML is a tag section named <EntityContainer Name="ODataService">. This container lists all SmartObjects available to the OData API. The EntitySet Name values are the SmartObject system-names. These names correspond with the EntityType Name value for the containers shown in the image above. Each container also lists the SmartObject properties' name and type.

Adding the entity name to the URL returns the records in that SmartObject.

https://{{base_URL}}/EmployeeSamples

You would get the same data if you used the ?method=GetList query.

https://{{base_URL}}/EmployeeSamples?method=GetList

Return the list of SmartObject methods

To get a list of the SmartObject methods, use the /ml/methods/ endpoint and specify the name of the EntitySet:

https://{{base_URL}}/ml/methods/EmployeeSamples

Use the filter query string parameter

If you want to return only employee data for employees whose names start with the letter A, use this URL:

https://{{base_URL}}/EmployeeSamples?method=List&$filter=startswith(FirstName, 'A')

Now you have all the information about the SmartObject that you need to interact with it.

Use this example Postman collection to familiarize yourself with the SmartObject OData v4 API.

OData v4 Employee Sample.postman_collection.json

To use the collection:

1. Expose your EmployeeSample SmartObject to your OData v4 API.
2. Import the OData v4 Employee Sample.postman_collection.json collection into Postman.
3. Edit the following environment variables in Postman for your environment:

   • {{base_URL}}

   • {{username}}

   • {{password}}

Use the read method when working with a SmartObject where the identifier is the primary key. It uses the GET method to retrieve the entity data based on the identifier supplied.

Use this method if you are working with a SmartObject where the identifier is not the primary key. It uses the POST method to retrieve the entity data based on the identifier parsed in the body.

1. Set the parameter to use the Load method, which loads data from the API.
   

2. Specify an identifier in the body for the data that must be returned. You can specify multiple identifiers in the body.
   

This method creates a new entity in the SmartObject.

1. Set a parameter to use the Create method.
   

2. Specify the new entity details in the body. You don't need to specify an ID, as the system will automatically generate one for the new entry.
   

This method updates the details of an existing entity in the SmartObject.

1. Set a parameter to use the Save method.
   

2. Specify the ID of the entity that must be updated, and then specify the information that must be updated along with its identifier such as shown in the image below.
   

This method deletes an existing entity in the SmartObject.

1. Set a parameter to use the Delete method.
   

2. Specify the ID of the entity that must be deleted in the body.
   

This method retrieves a list of entities from the SmartObject.

Set a parameter to use the GetList method, thereby returning the details of all the entities in the SmartObject.