Quick Start

Let's get started with REST APIs by making a simple REST call.

Prerequisites

Complete the following prerequisites before you start working with Oracle Field Service Cloud Service APIs:

Prerequisite More Information

Install cURL

Use cURL

Identify REST URLs

To access the Oracle Field Service Cloud Service APIs you must use the https://api.etadirect.com URL.

Note:

Always use the https:// URL scheme.

For example, the REST API endpoint URL to access the inventories resource in the Core API is https://api.etadirect.com/rest/ofscCore/v1/inventories. For more information about the various resources, refer to the Tasks section of this documentation.

Note:

All REST API endpoints are secured using TLSv1.2 encryption. Therefore, client applications must support TLSv1.2.

Step 1: Authenticate

Before you start using the REST APIs, you must authenticate and authorize their usage. There are different types of authentication mechanisms that the client uses to send credentials. For more information, refer to Authenticate.

Step 2: Make a Test REST API Call

After authenticating and authorizing the API usage, you can send a sample request to ensure that your connection works. For more information about testing, see Test. For example, if you want to retrieve basic instance information, such as OFSC version, API versions, and so on, you can use the following cURL command:

curl -s -u 'user@instanceId:passwd' --url 'https://api.etadirect.com/rest/ofscCore/'

If the request is successful, then you should receive a 200 response with a body such as the following:

{
    "items": [
        {
            "version": "v1",
            "isLatest": true,
            "catalog": {
                "ofscPlatformVersion": "17.2",
                "links": [
                    {
                        "rel": "canonical",
                        "href": "https://api.etadirect.com/rest/ofscCore/v1/metadata-catalog"
                    }
                ]
            },
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://api.etadirect.com/rest/ofscCore/v1"
                }
            ]
        }
    ],
    "links": [
        {
            "rel": "canonical",
            "href": "https://api.etadirect.com/rest/ofscCore"
        }
    ]
}


Congratulations! Now you're ready to send requests and start working with Oracle Field Service Cloud Service REST APIs.