Access Metadata

Oracle Field Service Cloud provides metadata about all REST API endpoints in the format of OpenAPI version 2.0 (Also known as Swagger 2.0). This Metadata may be used to discover endpoints, request format, response format by tools that support OpenAPI 2.0.

Oracle Field Service Cloud returns a separate Swagger file for top-level category. Use the GET operation with the following URIs to list the metadata catalog:

Use the GET operation with the following URI to list the metadata catalog:

• Core API: https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscCore/v1/metadata-catalog
• Metadata API: https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/metadata-catalog
• Statistics API: https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscStatistics/v1/metadata-catalog
• Capacity API: https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscCapacity/v1/metadata-catalog

Requesting the metadata catalog returns the list of resources, both standard and custom objects, for example:

Request:

curl -u 'clientId@instanceName:clientSecret' --url 'https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/metadata-catalog'

Response:

{
    "swagger": "2.0",
    "info": {
        "title": "OFSC Capacity Api",
        "description": "Api description",
        "version": "1.0"
    },
    "host": "localhost",
    "schemes": [
        "https"
    ],
    "produces": [
        "application/json"
    ],
    "basePath": "/rest/ofscCapacity/v1",
    "tags": [
        {
            "name": "Capacity/Booking",
            "description": "Booking operations"
        },
        {
            "name": "Capacity/Quota",
            "description": "Quota operations"
        },
        {
            "name": "Capacity/Booking Closing Schedule",
            "description": "Booking Closing operations"
        }
           ]
}