Using the Metadata Catalog

In the May 2016 release, the metadata catalog was enhanced to provide more useful information, such as whether resources and their fields are read-only (GET) or writeable (POST and PATCH), and supported query parameters.

Here are some ways to use the metadata catalog:

Listing the Metadata Catalog

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

https://your_site_interface/services/rest/connect/v1.4/metadata-catalog

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

{
    "items": [
    {
        "name": "accounts",
        "links": [
        {
            "rel": "alternate",
            "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/accounts",
            "mediaType": "application/schema+json"
            },
        {
            "rel": "canonical",
            "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/accounts",
            "mediaType": "application/json"
            },
        {
            "rel": "describes",
            "href": "https://mysite.example.com/services/rest/connect/v1.4/accounts"
            }
        ]
    },
    {
        "name": "analyticsReports",
        "links": [
        {
            "rel": "alternate",
            "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/analyticsReports",
            "mediaType": "application/schema+json"
            },
        {
            "rel": "canonical",
            "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/analyticsReports",
            "mediaType": "application/json"
            },
        {
            "rel": "describes",
            "href": "https://mysite.example.com/services/rest/connect/v1.4/analyticsReports"
            }
        ]
    },
    ...
    {
        "name": "namedIDs",
        "links": [
        {
            "rel": "alternate",
            "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/namedIDs",
            "mediaType": "application/schema+json"
            },
        {
            "rel": "canonical",
            "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/namedIDs",
            "mediaType": "application/json"
            },
        {
            "rel": "describes",
            "href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDs"
            }
        ]
    },
    {
        "name": "queryResults",
        "links": [
        {
            "rel": "alternate",
            "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/queryResults",
            "mediaType": "application/schema+json"
            },
        {
            "rel": "canonical",
            "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/queryResults",
            "mediaType": "application/json"
            },
        {
            "rel": "describes",
            "href": "https://mysite.example.com/services/rest/connect/v1.4/queryResults"
            }
        ]
    }
    ],
    "links": [
    {
        "rel": "canonical",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog"
        },
    {
        "rel": "describedby",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog",
        "mediaType": "application/schema+json"
        }
    ]
}

Retrieving Detailed Metadata for a Resource

To retrieve detailed metadata for a resource, use a GET request against its corresponding metadata-catalog resource:

https://your_site_interface/services/rest/connect/version/metadata-catalog/resource

with the header listed in the following table:

Header Value
Accept application/schema+json

Note:

Because detailed metadata-catalog requests require an Accept header, it's recommended to use a REST client such as Postman or Advanced Rest Client for such requests.

Request URI example

For example, to retrieve the metadata for the opportunities resource, use a GET request with the following syntax and an Accept header:

https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/opportunities

Response body example

Boolean attributes for opportunity fields show the available operations on those fields:

  • isAvailableForGET
  • isAvailableForPOST
  • isAvailableForPATCH

Supported query parameters are listed in the instances links at the end of the response under links.

{
  "$schema": "https://mysite.example.com/services/rest/connect/v1.4/schemas/
    ConnectOracleRESTStandard#",
  "title": "Resource Schema",
  "description": "Schema representing a typed resource",
  "type": "object",
  "allOf": [
    {
      "$ref": "https://mysite.example.com/services/rest/connect/v1.4/schemas/
        ConnectOracleRESTStandard#/definitions/collectionPagedResource"
    }
  ],
  "definitions": {
    "singularResource": {
      "allOf": [
        {
          "$ref": "https://mysite.example.com/services/rest/connect/v1.4/schemas/
            ConnectOracleRESTStandard#/definitions/resourceMeta"
        }
      ],
      "type": "object",
      "description": "Sales opportunity with a contact or organization",
      "name": "opportunities",
      "isMenu": false,
      "releaseIntroduced": "15.5",
      "properties": {
        "id": {
          "description": "Primary key identifier",
          "releaseIntroduced": "15.5",
          "isDeprecated": false,
          "isEnumerable": false,
          "label": "ID",
          "nullable": false,
          "isAvailableForGET": true,
          "isAvailableForPOST": false,
          "isAvailableForPATCH": false,
          "minimum": 1,
          "maximum": 9223372036854775807,
          "usedAsName": false,
          "type": "integer"
        },
        "lookupName": {
          "description": "Name used to lookup this object",
          "releaseIntroduced": "15.5",
          "isDeprecated": false,
          "isEnumerable": false,
          "label": "LookupName",
          "nullable": false,
          "isAvailableForGET": true,
          "isAvailableForPOST": false,
          "isAvailableForPATCH": false,
          "maxLength": 255,
          "usedAsName": false,
          "type": "string"
        },
        "createdTime": {
          "description": "Creation date and time.  Read-only",
          "releaseIntroduced": "15.5",
          "isDeprecated": false,
          "isEnumerable": false,
          "label": "CreatedTime",
          "nullable": false,
          "isAvailableForGET": true,
          "isAvailableForPOST": false,
          "isAvailableForPATCH": false,
          "minimumDateTime": "1970-01-02T00:00:00Z",
          "maximumDateTime": "2038-01-17T23:59:59Z",
          "usedAsName": false,
          "type": "string"
        },
        "updatedTime": {
          "description": "Last updated date and time.  Read-only",
          "releaseIntroduced": "15.5",
          "isDeprecated": false,
          "isEnumerable": false,
          "label": "UpdatedTime",
          "nullable": false,
          "isAvailableForGET": true,
          "isAvailableForPOST": false,
          "isAvailableForPATCH": false,
          "minimumDateTime": "1970-01-02T00:00:00Z",
          "maximumDateTime": "2038-01-17T23:59:59Z",
          "usedAsName": false,
          "type": "string"
        },
        "accountHierarchy": {
          "description": "Full manager hierarchy of staff accounts for the salesperson that was
           assigned to the opportunity at the time of assignment.  Read-only",
          "releaseIntroduced": "15.5",
          "isDeprecated": false,
          "isEnumerable": false,
          "label": "AccountHierarchy",
          "nullable": true,
          "isAvailableForGET": true,
          "isAvailableForPOST": false,
          "isAvailableForPATCH": false,
          "maxDepth": 12,
          "usedAsName": false,
          "type": [
            "array",
            "null"
          ],
          "maxItems": 12,
          "items": {
            "type": "object",
            "$ref": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/accounts"
          }
        },
        "assignedToAccount": {
          "description": "Assigned sales representative",
          "releaseIntroduced": "15.5",
          "isDeprecated": false,
          "isEnumerable": true,
          "label": "AssignedToAccount",
          "nullable": true,
          "isAvailableForGET": true,
          "isAvailableForPOST": true,
          "isAvailableForPATCH": true,
          "maxDepth": 11,
          "usedAsName": false,
          "type": [
            "object",
            "null"
          ],
          "$ref": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/accounts"
        },
        "banner": {
          "description": "Banner display flag",
          "releaseIntroduced": "15.5",
          "isDeprecated": false,
          "isEnumerable": false,
          "label": "Banner",
          "nullable": true,
          "isAvailableForGET": true,
          "isAvailableForPOST": true,
          "isAvailableForPATCH": true,
          "usedAsName": false,
          "type": [
            "object",
            "null"
          ],
          "$ref": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/
            opportunities/banner"
        },
        "campaign": {
          "description": "Campaign that created the opportunity, if applicable.  This value and the
           survey are mutually exclusive; one or both must be null.  Read-only",
          "releaseIntroduced": "15.5",
          "isDeprecated": false,
          "isEnumerable": true,
          "label": "Campaign",
          "nullable": true,
          "isAvailableForGET": true,
          "isAvailableForPOST": false,
          "isAvailableForPATCH": false,
          "usedAsName": false,
          "type": [
            "object",
            "null"
          ],
          "$ref": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/namedIDs/
            opportunities/campaign"
        },
        "closedTime": {
          "description": "Date and time the opportunity was closed",
          "releaseIntroduced": "15.5",
          "isDeprecated": false,
          "isEnumerable": false,
          "label": "ClosedTime",
          "nullable": true,
          "isAvailableForGET": true,
          "isAvailableForPOST": true,
          "isAvailableForPATCH": true,
          "minimumDateTime": "1970-01-02T00:00:00Z",
          "maximumDateTime": "2038-01-17T23:59:59Z",
          "usedAsName": false,
          "type": [
            "string",
            "null"
          ]
        },
        "closedValue": {
          "description": "Monetary value when opportunity was closed",
          "releaseIntroduced": "15.5",
          "isDeprecated": false,
          "isEnumerable": false,
          "label": "ClosedValue",
          "nullable": true,
          "isAvailableForGET": true,
          "isAvailableForPOST": true,
          "isAvailableForPATCH": true,
          "usedAsName": false,
          "type": [
            "object",
            "null"
          ],
          "$ref": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/
            opportunities/closedValue"
        },
        "costOfSale": {
          "description": "Associated cost of sale",
          "releaseIntroduced": "15.5",
          "isDeprecated": false,
          "isEnumerable": false,
          "label": "CostOfSale",
          "nullable": true,
          "isAvailableForGET": true,
          "isAvailableForPOST": true,
          "isAvailableForPATCH": true,
          "usedAsName": false,
          "type": [
            "object",
            "null"
          ],
          "$ref": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/
            opportunities/costOfSale"
        },
        "customFields": {
          "description": "List of custom field values",
          "releaseIntroduced": "15.5",
          "isDeprecated": false,
          "isEnumerable": false,
          "label": "CustomFields",
          "nullable": false,
          "isAvailableForGET": true,
          "isAvailableForPOST": true,
          "isAvailableForPATCH": true,
          "usedAsName": false,
          "type": "object",
          "$ref": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/
            opportunities/customFields"
        },
        "fileAttachments": {
          "description": "List of file attachments",
          "releaseIntroduced": "15.5",
          "isDeprecated": false,
          "isEnumerable": false,
          "label": "FileAttachments",
          "nullable": true,
          "isAvailableForGET": true,
          "isAvailableForPOST": true,
          "isAvailableForPATCH": true,
          "usedAsName": false,
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": "object",
            "$ref": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/
              opportunities/fileAttachments"
          }
        },
        "forecastCloseDate": {
          "description": "Date on which the opportunity is forecasted to close",
          "releaseIntroduced": "15.5",
          "isDeprecated": false,
          "isEnumerable": false,
          "label": "ForecastCloseDate",
          "nullable": true,
          "isAvailableForGET": true,
          "isAvailableForPOST": true,
          "isAvailableForPATCH": true,
          "minimumDate": "1970-01-02",
          "maximumDate": "2038-01-17",
          "usedAsName": false,
          "type": [
            "string",
            "null"
          ]
        },
        "initialContactDate": {
          "description": "Date on which the sales representative initially made contact with the
           organization",
          "releaseIntroduced": "15.5",
          "isDeprecated": false,
          "isEnumerable": false,
          "label": "InitialContactDate",
          "nullable": true,
          "isAvailableForGET": true,
          "isAvailableForPOST": true,
          "isAvailableForPATCH": true,
          "minimumDate": "1970-01-02",
          "maximumDate": "2038-01-17",
          "usedAsName": false,
          "type": [
            "string",
            "null"
          ]
        },
        "interface": {
          "description": "Interface with which the opportunity is associated",
          "releaseIntroduced": "15.5",
          "isDeprecated": false,
          "isEnumerable": true,
          "label": "Interface",
          "nullable": false,
          "isAvailableForGET": true,
          "isAvailableForPOST": true,
          "isAvailableForPATCH": true,
          "usedAsName": false,
          "type": "object",
          "$ref": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/
            siteInterfaces"
        },
        "leadRejectDateTime": {
          "description": "Date and time the lead was rejected",
          "releaseIntroduced": "15.5",
          "isDeprecated": false,
          "isEnumerable": false,
          "label": "LeadRejectDateTime",
          "nullable": true,
          "isAvailableForGET": true,
          "isAvailableForPOST": true,
          "isAvailableForPATCH": true,
          "minimumDateTime": "1970-01-02T00:00:00Z",
          "maximumDateTime": "2038-01-17T23:59:59Z",
          "usedAsName": false,
          "type": [
            "string",
            "null"
          ]
        },
        "leadRejectDescription": {
          "description": "Comments entered when the lead was rejected",
          "releaseIntroduced": "15.5",
          "isDeprecated": false,
          "isEnumerable": false,
          "label": "LeadRejectDescription",
          "nullable": true,
          "isAvailableForGET": true,
          "isAvailableForPOST": true,
          "isAvailableForPATCH": true,
          "maxLength": 1333,
          "maxBytes": 4000,
          "usedAsName": false,
          "type": [
            "string",
            "null"
          ]
        },
        "leadRejectReason": {
          "description": "Reason the lead was rejected",
          "releaseIntroduced": "15.5",
          "isDeprecated": false,
          "isEnumerable": true,
          "label": "LeadRejectReason",
          "nullable": true,
          "isAvailableForGET": true,
          "isAvailableForPOST": true,
          "isAvailableForPATCH": true,
          "usedAsName": false,
          "type": [
            "object",
            "null"
          ],
          "$ref": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/namedIDs/
            opportunities/leadRejectReason"
        },
        "lostTime": {
          "description": "Date and time at which the opportunity was lost",
          "releaseIntroduced": "15.5",
          "isDeprecated": false,
          "isEnumerable": false,
          "label": "LostTime",
          "nullable": true,
          "isAvailableForGET": true,
          "isAvailableForPOST": true,
          "isAvailableForPATCH": true,
          "minimumDateTime": "1970-01-02T00:00:00Z",
          "maximumDateTime": "2038-01-17T23:59:59Z",
          "usedAsName": false,
          "type": [
            "string",
            "null"
          ]
        },
        "managerCommit": {
          "description": "Committed status of the manager-forecasted value",
          "releaseIntroduced": "15.5",
          "isDeprecated": false,
          "isEnumerable": false,
          "label": "ManagerCommit",
          "nullable": false,
          "isAvailableForGET": true,
          "isAvailableForPOST": true,
          "isAvailableForPATCH": true,
          "usedAsName": false,
          "type": "boolean"
        },
        "managerValue": {
          "description": "Manager-forecasted value",
          "releaseIntroduced": "15.5",
          "isDeprecated": false,
          "isEnumerable": false,
          "label": "ManagerValue",
          "nullable": true,
          "isAvailableForGET": true,
          "isAvailableForPOST": true,
          "isAvailableForPATCH": true,
          "usedAsName": false,
          "type": [
            "object",
            "null"
          ],
          "$ref": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/
            opportunities/managerValue"
        },
        "name": {
          "description": "Descriptive name",
          "releaseIntroduced": "15.5",
          "isDeprecated": false,
          "isEnumerable": false,
          "label": "Name",
          "nullable": true,
          "isAvailableForGET": true,
          "isAvailableForPOST": true,
          "isAvailableForPATCH": true,
          "pattern": "^[^\t\n]*$",
          "maxLength": 80,
          "usedAsName": true,
          "type": [
            "string",
            "null"
          ]
        },
        "notes": {
          "description": "List of associated notes",
          "releaseIntroduced": "15.5",
          "isDeprecated": false,
          "isEnumerable": false,
          "label": "Notes",
          "nullable": true,
          "isAvailableForGET": true,
          "isAvailableForPOST": true,
          "isAvailableForPATCH": true,
          "usedAsName": false,
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": "object",
            "$ref": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/
              opportunities/notes"
          }
        },
        "organization": {
          "description": "Associated organization",
          "releaseIntroduced": "15.5",
          "isDeprecated": false,
          "isEnumerable": false,
          "label": "Organization",
          "nullable": true,
          "isAvailableForGET": true,
          "isAvailableForPOST": true,
          "isAvailableForPATCH": true,
          "usedAsName": false,
          "type": [
            "object",
            "null"
          ],
          "$ref": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/organizations"
        },
        "otherContacts": {
          "description": "Other non-primary associated contacts",
          "releaseIntroduced": "15.5",
          "isDeprecated": false,
          "isEnumerable": false,
          "label": "OtherContacts",
          "nullable": true,
          "isAvailableForGET": true,
          "isAvailableForPOST": true,
          "isAvailableForPATCH": true,
          "usedAsName": false,
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": "object",
            "$ref": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/
              opportunities/otherContacts"
          }
        },
        "primaryContact": {
          "description": "Primary contact",
          "releaseIntroduced": "15.5",
          "isDeprecated": false,
          "isEnumerable": false,
          "label": "PrimaryContact",
          "nullable": true,
          "isAvailableForGET": true,
          "isAvailableForPOST": true,
          "isAvailableForPATCH": true,
          "usedAsName": false,
          "type": [
            "object",
            "null"
          ],
          "$ref": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/
            opportunities/primaryContact"
        },
        "quotes": {
          "description": "List of sales quotes",
          "releaseIntroduced": "15.5",
          "isDeprecated": false,
          "isEnumerable": false,
          "label": "Quotes",
          "nullable": true,
          "isAvailableForGET": true,
          "isAvailableForPOST": true,
          "isAvailableForPATCH": true,
          "usedAsName": false,
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": "object",
            "$ref": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/
              opportunities/quotes"
          }
        },
        "recallTime": {
          "description": "Recall date and time",
          "releaseIntroduced": "15.5",
          "isDeprecated": false,
          "isEnumerable": false,
          "label": "RecallTime",
          "nullable": true,
          "isAvailableForGET": true,
          "isAvailableForPOST": true,
          "isAvailableForPATCH": true,
          "minimumDateTime": "1970-01-02T00:00:00Z",
          "maximumDateTime": "2038-01-17T23:59:59Z",
          "usedAsName": false,
          "type": [
            "string",
            "null"
          ]
        },
        "returnValue": {
          "description": "Return value",
          "releaseIntroduced": "15.5",
          "isDeprecated": false,
          "isEnumerable": false,
          "label": "ReturnValue",
          "nullable": true,
          "isAvailableForGET": true,
          "isAvailableForPOST": true,
          "isAvailableForPATCH": true,
          "usedAsName": false,
          "type": [
            "object",
            "null"
          ],
          "$ref": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/
            opportunities/returnValue"
        },
        "salesRepresentativeCommit": {
          "description": "Committed status of the sales representative-forecasted value",
          "releaseIntroduced": "15.5",
          "isDeprecated": false,
          "isEnumerable": false,
          "label": "SalesRepresentativeCommit",
          "nullable": false,
          "isAvailableForGET": true,
          "isAvailableForPOST": true,
          "isAvailableForPATCH": true,
          "usedAsName": false,
          "type": "boolean"
        },
        "salesRepresentativeValue": {
          "description": "Sales representative-forecasted value",
          "releaseIntroduced": "15.5",
          "isDeprecated": false,
          "isEnumerable": false,
          "label": "SalesRepresentativeValue",
          "nullable": true,
          "isAvailableForGET": true,
          "isAvailableForPOST": true,
          "isAvailableForPATCH": true,
          "usedAsName": false,
          "type": [
            "object",
            "null"
          ],
          "$ref": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/
            opportunities/salesRepresentativeValue"
        },
        "source": {
          "description": "Creation source IDs.  Read-only",
          "releaseIntroduced": "15.5",
          "isDeprecated": false,
          "isEnumerable": true,
          "label": "Source",
          "nullable": false,
          "isAvailableForGET": true,
          "isAvailableForPOST": false,
          "isAvailableForPATCH": false,
          "maxDepth": 1,
          "usedAsName": false,
          "type": "object",
          "$ref": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/
            namedIDHierarchies/opportunities/source"
        },
        "stageWithStrategy": {
          "description": "Current stage of opportunity handling process, along with its associated
           strategy",
          "releaseIntroduced": "15.5",
          "isDeprecated": false,
          "isEnumerable": false,
          "label": "StageWithStrategy",
          "nullable": false,
          "isAvailableForGET": true,
          "isAvailableForPOST": true,
          "isAvailableForPATCH": true,
          "usedAsName": false,
          "type": "object",
          "$ref": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/
            opportunities/stageWithStrategy"
        },
        "statusWithType": {
          "description": "Current status and associated status type",
          "releaseIntroduced": "15.5",
          "isDeprecated": false,
          "isEnumerable": false,
          "label": "StatusWithType",
          "nullable": false,
          "isAvailableForGET": true,
          "isAvailableForPOST": true,
          "isAvailableForPATCH": true,
          "usedAsName": false,
          "type": "object",
          "$ref": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/
            opportunities/statusWithType"
        },
        "summary": {
          "description": "Brief summary description",
          "releaseIntroduced": "15.5",
          "isDeprecated": false,
          "isEnumerable": false,
          "label": "Summary",
          "nullable": true,
          "isAvailableForGET": true,
          "isAvailableForPOST": true,
          "isAvailableForPATCH": true,
          "maxLength": 1333,
          "maxBytes": 4000,
          "usedAsName": false,
          "type": [
            "string",
            "null"
          ]
        },
        "survey": {
          "description": "Survey that created the opportunity, if applicable.  This value and the
           campaign are mutually exclusive; one or both must be null.  Read-only",
          "releaseIntroduced": "15.5",
          "isDeprecated": false,
          "isEnumerable": true,
          "label": "Survey",
          "nullable": true,
          "isAvailableForGET": true,
          "isAvailableForPOST": false,
          "isAvailableForPATCH": false,
          "usedAsName": false,
          "type": [
            "object",
            "null"
          ],
          "$ref": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/namedIDs/
            opportunities/survey"
        },
        "territory": {
          "description": "Associated sales territory",
          "releaseIntroduced": "15.5",
          "isDeprecated": false,
          "isEnumerable": false,
          "label": "Territory",
          "nullable": true,
          "isAvailableForGET": true,
          "isAvailableForPOST": true,
          "isAvailableForPATCH": true,
          "maxDepth": 11,
          "usedAsName": false,
          "type": [
            "object",
            "null"
          ],
          "$ref": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/
            salesTerritories"
        },
        "territoryHierarchy": {
          "description": "Full territory hierarchy of sales territories for the territory that was
           assigned to the opportunity at the time of assignment. Read-only",
          "releaseIntroduced": "15.5",
          "isDeprecated": false,
          "isEnumerable": false,
          "label": "TerritoryHierarchy",
          "nullable": true,
          "isAvailableForGET": true,
          "isAvailableForPOST": false,
          "isAvailableForPATCH": false,
          "maxDepth": 12,
          "usedAsName": false,
          "type": [
            "array",
            "null"
          ],
          "maxItems": 12,
          "items": {
            "type": "object",
            "$ref": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/
              salesTerritories"
          }
        },
        "winLossDescription": {
          "description": "Win/loss description",
          "releaseIntroduced": "15.5",
          "isDeprecated": false,
          "isEnumerable": false,
          "label": "WinLossDescription",
          "nullable": true,
          "isAvailableForGET": true,
          "isAvailableForPOST": true,
          "isAvailableForPATCH": true,
          "maxLength": 1333,
          "maxBytes": 4000,
          "usedAsName": false,
          "type": [
            "string",
            "null"
          ]
        },
        "winLossReason": {
          "description": "Win/loss reason",
          "releaseIntroduced": "15.5",
          "isDeprecated": false,
          "isEnumerable": true,
          "label": "WinLossReason",
          "nullable": true,
          "isAvailableForGET": true,
          "isAvailableForPOST": true,
          "isAvailableForPATCH": true,
          "usedAsName": false,
          "type": [
            "object",
            "null"
          ],
          "$ref": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/namedIDs/
            opportunities/winLossReason"
        }
      }
    }
  },
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "$ref": "#/definitions/singularResource/properties/id"
          },
          "lookupName": {
            "$ref": "#/definitions/singularResource/properties/lookupName"
          },
          "createdTime": {
            "$ref": "#/definitions/singularResource/properties/createdTime"
          },
          "updatedTime": {
            "$ref": "#/definitions/singularResource/properties/updatedTime"
          }
        }
      }
    }
  },
  "links": [
    {
      "rel": "self",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/opportunities",
      "mediaType": "application/schema+json"
    },
    {
      "rel": "describes",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/opportunities"
    },
    {
      "rel": "search",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/opportunities",
      "schema": {
        "type": "object",
        "properties": {
          "q": {
            "description": "Query parameter that allows searching by providing ROQL WHERE clause
             filtering",
            "type": "string",
            "format": "https://mysite.example.com/services/rest/connect/v1.4/opportunities-search-form"
          }
        }
      }
    },
    {
      "title": "Retrieve collection of opportunities",
      "rel": "instances",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/opportunities",
      "mediaType": "application/json;type=collection",
      "method": "GET",
      "schema": {
        "type": "object",
        "properties": {
          "offset": {
            "$ref": "https://mysite.example.com/services/rest/connect/v1.4/schemas/
              OracleRESTStandard#/definitions/offsetQueryParam"
          },
          "limit": {
            "$ref": "https://mysite.example.com/services/rest/connect/v1.4/schemas/
              OracleRESTStandard#/definitions/limitQueryParam"
          },
          "fields": {
            "$ref": "https://mysite.example.com/services/rest/connect/v1.4/schemas/
              OracleRESTStandard#/definitions/fieldsQueryParam"
          },
          "orderBy": {
            "$ref": "https://mysite.example.com/services/rest/connect/v1.4/schemas/
              OracleRESTStandard#/definitions/orderByQueryParam"
          },
          "totalResults": {
            "$ref": "https://mysite.example.com/services/rest/connect/v1.4/schemas/
              OracleRESTStandard#/definitions/totalResultsQueryParam"
          }
        }
      }
    },
    {
      "title": "Create an instance of opportunities",
      "rel": "create",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/opportunities",
      "method": "POST",
      "schema": {
        "$ref": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/
          opportunities#/definitions/singularResource"
      }
    }
  ]
}

Retrieving Request Syntax for a Resource

To retrieve the syntax for requests against a resource, use a GET request with the following syntax:

https://your_site_interface/services/rest/connect/version/metadata-catalog/resource#/definitions

Note:

Request syntax isn't available for special resources, such as queryResults, NamedIDs, and NamedIDHierarchies.

Request URI example

For example, to retrieve the request syntax for the incidents resource, use the following GET request:

https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/incidents#/definitions

Response body example

The following are returned:

  • Link to ROQL object query syntax
  • GET request syntax (if available), as well as links to definitions for supported query parameters
  • POST request syntax (if available), as well as parameters and required fields
{
  "name": "incidents",
  "links": [
    {
      "rel": "alternate",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/incidents",
      "mediaType": "application/schema+json"
    },
    {
      "rel": "describes",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/incidents"
    },
    {
      "rel": "search",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/incidents",
      "schema": {
        "type": "object",
        "properties": {
          "q": {
            "description": "Query parameter that allows searching by providing ROQL WHERE clause
             filtering",
            "type": "string",
            "format": "https://mysite.example.com/services/rest/connect/v1.4/incidents-search-form"
          }
        }
      }
    },
    {
      "title": "Retrieve collection of incidents",
      "rel": "instances",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/incidents",
      "mediaType": "application/json;type=collection",
      "method": "GET",
      "schema": {
        "type": "object",
        "properties": {
          "offset": {
            "$ref": "https://mysite.example.com/services/rest/connect/v1.4/schemas/
              OracleRESTStandard#/definitions/offsetQueryParam"
          },
          "limit": {
            "$ref": "https://mysite.example.com/services/rest/connect/v1.4/schemas/
              OracleRESTStandard#/definitions/limitQueryParam"
          },
          "fields": {
            "$ref": "https://mysite.example.com/services/rest/connect/v1.4/schemas/
              OracleRESTStandard#/definitions/fieldsQueryParam"
          },
          "orderBy": {
            "$ref": "https://mysite.example.com/services/rest/connect/v1.4/schemas/
              OracleRESTStandard#/definitions/orderByQueryParam"
          },
          "totalResults": {
            "$ref": "https://mysite.example.com/services/rest/connect/v1.4/schemas/
              OracleRESTStandard#/definitions/totalResultsQueryParam"
          }
        }
      }
    },
    {
      "title": "Create an instance of incidents",
      "rel": "create",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/incidents",
      "method": "POST",
      "schema": {
        "$ref": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/
         incidents#/definitions/singularResource",
        "required": [
          "primaryContact"
        ]
      }
    }
  ]
}