Structure of the API URL
1 min
the api url is structured as follows {tenant url}/{base api url}/{business object name}({'business object unique key'})?${query parameter and value} where, {tenant url} required the tenant url to access the server example, https //xyz api example com {base api url} required the fixed path to access the api resource, it is used for all api calls expect for log in and log out fixed path api/odata/businessobject fixed path for log in and log out apis /api/rest/authentication {business object name} required the business object name example, incidents, alerts, and changes {(business object unique key)} optional the business object unique key is the recid which is used to request a specific resource or business object example, ('02818a8426c9402e8dfe7c8d3132f783') {query parameter and value} optional the query parameter and value will be required based on the request such as to get only the top 10 incidents from the list or to get incidents by a specific owner examples, ?$top=10 ?$filter=owner eq 'jclerk' endpoint examples https //xyz api example com/api/odata/businessobject/incidents https //xyz api example com/api/odata/businessobject/alerts https //xyz api example com/api/odata/businessobject/employees https //xyz api example com/api/odata/businessobject/incidents?$search=printer https //xyz api example com/api/odata/businessobject/incidents?$filter=status eq 'active'
