-
You are expected to have a good level of knowledge and experience using OData, managing Web APIs, the schema model, API groups, and your systems metadata to construct the OData syntax.
-
The service calls shown in this document are EXAMPLES of the OData syntax that can be used to create a service call or POST. Each example can be used as a template to construct service calls using the metadata from your SDx system, and use a short annotation of the full host URL address.
OData provides a uniform structure to define the ways to expose the metadata to the Web Client so you can manipulate the data through the create, read, update, and delete operations. The Web API v1 and v2 makes it easy to create an OData endpoint for a data set. You can control exactly which OData operations the endpoint supports.
The following sections detail Web API v1 or v2 examples of the syntax, headers, and service calls that can be used to create an OData POST or GET request. These can easily be configured for your own system.
To send a request to the SDx API, your URL must include specific components in a specific order. This documentation shortens URL paths by using <Access_URL> as a placeholder for some of the URL components. To learn more about URL components and the <Access_URL> placeholder, see Service Request URL Formation.
For API calls that request to amend or get server data, the user must be related
to the specific roles and activated. For more information on how to activate roles
for a user using OData, see Set user roles.