1. REST API for Oracle Field Service Cloud Service REST API for Oracle Field Service Cloud Service
  2. Reference
  3. Terminology

Terminology

If you're new to Oracle Applications Cloud REST APIs, you're bound to run into unfamiliar terms. Review these definitions to better understand the tech lingo.

  • Base64: Encoding schemes that convert binary data to a text string format. Base64 encodes by dividing a string of bytes into groups of bits, so that each group maps to one of 64 characters.

  • Basic Authentication: A simple and commonly used identifying process built into the HTTP protocol that collects the authentication credentials. The client sends HTTP requests with the Authorization header in the Base64-encoded format. For Oracle Field Service the format is, Basic <CLIENT_ID>@<INSTANCE_NAME>:<CLIENT_SECRET>. It's usually implemented with a secondary level of security.

  • Collection Resource: Represents a list of entities, such as users or activities.

  • Endpoint: A URI on a server that can return a response. The terms resource and endpoint can be used interchangeably.

  • HTTP Header: components of request and response messages in Hypertext Transfer Protocol (HTTP) that carry information and define the operating parameters of an HTTP transaction. For examples, see Work with your REST Client.

  • Resource: An object with a type, associated data, and relationships to other resources. Examples include a single document, image, object, or a collection of resources. You can use a set of HTTP methods to access a resource. To learn more, see Resource Types.

  • Resource Representation: The current or intended resource state, delivered as a server response. It includes, in JSON format, both the metadata and state of the data .

  • Response Payload: Data that the server returns when answering an HTTP request. The response payload might be a JSON, XML, or text document.

  • Singular Resource: Represents a single entity, such as a user or an activity. To learn more, see Resource Types.

  • Subresource: A type of resource used to make its relationship to other entities more obvious. Its relationship type can be parent-child, such as user collaboration groups to users.

  • Uniform Resource Identifier (URI): Part or all of a path used to address a particular resource involved in an interaction. Examples of URIs include URLs (Uniform Resource Locator) and URNs (Uniform Resource Name). In the following URI example, the full address string is the URL, and the target resource, users, is the URN: https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscCore/v1/users