1. REST API for Oracle CX Sales and B2B ServiceREST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Adaptive Search
  3. Adaptive Search Examples
  4. Metamodels

Metamodels

This is an example of the root endpoint of the Adaptive Search REST Service

  • Version is the OSC unified version for Rest services.
  • Default limit is the limit applied by default to all collections.
  • There are child links to metamodels, entities and search operators.

cURL Commad

https://servername.fa.us2.oraclecloud.com/crmRestApi/searchResources/11.13.18.05/metaModels

Example Response Payload

{
    "items": [
        {
            "metaModelUuid": "e03596d3-fa2f-40a6-8e47-9067d024cf2e",
            "workflowState": "Active",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/searchResources/11.13.18.05/metaModels/e03596d3-fa2f-40a6-8e47-9067d024cf2e",
                    "kind": "item",
                    "name": "self"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/searchResources/11.13.18.05/metaModels/e03596d3-fa2f-40a6-8e47-9067d024cf2e",
                    "kind": "item",
                    "name": "canonical"
                },
                {
                    "rel": "parent",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/searchResources/11.13.18.05/metaModels",
                    "kind": "collection",
                    "name": "parent"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/searchResources/11.13.18.05/entities?metaModelUuid=e03596d3-fa2f-40a6-8e47-9067d024cf2e",
                    "kind": "collection",
                    "name": "entities"
                }
            ]
        }
...
}

Entities

The following sample gives back the list of entities. Please use include=all if want to get actions as well.

  • Entity Name signifies the name of this entity.
  • Localized Name is the plural display name for this entity.
  • isDocument signifies if this is a top level entity.
  • isEnabled signifies if this entity is enabled.
  • adfRestResourceName is the key to adfBC Rest resource name.
  • adfRestPrimaryKeyAttributeName is the Primary key in ADF Bc.
  • To get only entities which have the user has access to, please pass query parameter accessible = true

cURL Command

https://servername.fa.us2.oraclecloud.com/crmRestApi/searchResources/11.13.18.05/entities?include=all&limit=2

Example Response Payload

{
    "items": [
        {
            "entityName": "PartnerContact",
            "localizedName": "Partner Contacts",
            "entityUuid": "ff01f270-cd8e-4cdb-aa19-3cc0526a46fd",
            "isDocument": true,
            "isEnabled": true,
            "adfRestResourceName": "partnerContacts",
            "adfRestPrimaryKeyAttributeName": "PartyNumber",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/searchResources/11.13.18.05/entities/PartnerContact?metaModelUuid=e03596d3-fa2f-40a6-8e47-9067d024cf2e&include=all",
                    "kind": "item",
                    "name": "self"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/searchResources/11.13.18.05/entities/PartnerContact?metaModelUuid=e03596d3-fa2f-40a6-8e47-9067d024cf2e&include=all",
                    "kind": "item",
                    "name": "canonical"
                },
                {
                    "rel": "parent",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/searchResources/11.13.18.05/entities?metaModelUuid=e03596d3-fa2f-40a6-8e47-9067d024cf2e&include=all",
                    "kind": "collection",
                    "name": "parent"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/searchResources/11.13.18.05/metaModels/e03596d3-fa2f-40a6-8e47-9067d024cf2e?limit=2&offset=3&include=all",
                    "kind": "item",
                    "name": "metaModel"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/searchResources/11.13.18.05/entities/PartnerContact/attributes?metaModelUuid=e03596d3-fa2f-40a6-8e47-9067d024cf2e&include=all",
                    "kind": "collection",
                    "name": "attributes"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/searchResources/11.13.18.05/entities/PartnerContact/fields?metaModelUuid=e03596d3-fa2f-40a6-8e47-9067d024cf2e&include=all",
                    "kind": "collection",
                    "name": "fields"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/searchResources/11.13.18.05/entities/PartnerContact/actions?metaModelUuid=e03596d3-fa2f-40a6-8e47-9067d024cf2e&include=all",
                    "kind": "collection",
                    "name": "actions"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/searchResources/11.13.18.05/custom-actions/queries?limit=2&metaModeIUuid=e03596d3-fa2f-40a6-8e47-9067d024cf2e&offset=3&include=all&entity=PartnerContact",
                    "kind": "collection",
                    "name": "queries"
                }
            ]
        },
...
}

Fields for an entity

To get all fields for an entity, following is a sample payload.

cURL Command

https://servername.fa.us2.oraclecloud.com/crmRestApi/searchResources/11.13.18.05/entities/Account/fields?metaModelUuid=e03596d3-fa2f-40a6-8e47-9067d024cf2e&limit=2&offset=20

Example Response Payload

{
    "items": [
        {
            "attributeUuid": "f60079d6-6880-4e62-9e10-3c992e58956d",
            "field": "LastUpdatedBy",
            "displayLabel": "Last Updated By",
            "attributeType": "Text",
            "isSearchable": true,
            "isAggregatable": true,
            "adfRestAttributeName": "LastUpdatedBy",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/searchResources/11.13.18.05/entities/Account/fields/LastUpdatedBy?metaModelUuid=e03596d3-fa2f-40a6-8e47-9067d024cf2e",
                    "kind": "item",
                    "name": "self"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/searchResources/11.13.18.05/entities/Account/fields/LastUpdatedBy?metaModelUuid=e03596d3-fa2f-40a6-8e47-9067d024cf2e",
                    "kind": "item",
                    "name": "canonical"
                },
                {
                    "rel": "parent",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/searchResources/11.13.18.05/entities/Account/fields?metaModelUuid=e03596d3-fa2f-40a6-8e47-9067d024cf2e",
                    "kind": "collection",
                    "name": "parent"
                }
            ]
        },
...
}

Attributes for an entity

To get all the Fusion Apps attributes for an entity.

cURL Command

https://servername.fa.us2.oraclecloud.com/crmRestApi/searchResources/11.13.18.05/entities/Account/attributes?limit=5

Example Response Payload

{
    "items": [
        {
            "attributeUuid": "df5f0e6a-1c4c-4143-8849-e12667e9107f",
            "attributeName": "CeoName",
            "localizedAttributeName": "Chief Executive Name",
            "attributeType": "Text",
            "minOccurs": 0,
            "maxOccurs": 1,
            "isEnabled": false,
            "isSearchable": true,
            "isSortable": true,
            "isIndexed": true,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/searchResources/11.13.18.05/entities/Account/attributes/df5f0e6a-1c4c-4143-8849-e12667e9107f?metaModelUuid=a8e5d34e-b9d8-4f59-8fe5-8fb2eb730974",
                    "kind": "item",
                    "name": "self"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/searchResources/11.13.18.05/entities/Account/attributes/df5f0e6a-1c4c-4143-8849-e12667e9107f?metaModelUuid=a8e5d34e-b9d8-4f59-8fe5-8fb2eb730974",
                    "kind": "item",
                    "name": "canonical"
                },
                {
                    "rel": "parent",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/searchResources/11.13.18.05/entities/Account/attributes?metaModelUuid=a8e5d34e-b9d8-4f59-8fe5-8fb2eb730974",
                    "kind": "collection",
                    "name": "parent"
                }
            ]
        },
...
}

Meanings for Enumerations

To describe the meanings and codes for an enumeration.

cURL Command

https://servername.fa.us2.oraclecloud.com/crmRestApi/searchResources/11.13.18.05/entities/Account/attributes/25a704d1-34e5-481a-846b-a3a43b61114b/meanings?

Example Response Payload

{
    "items": [
        {
            "lookupCode": "AUHG",
            "meaning": "AUHG"
        },
        {
            "lookupCode": "AUYTG Currency",
            "meaning": "AUYTG Currency Definition"
        },
...
}

Actions

Actions is an internal attribute and the user needs to pass include=all to see actions. It describes the different actions associated with an entity.

cURL Command

https://servername.fa.us2.oraclecloud.com/crmRestApi/searchResources/11.13.18.05/entities/Account/actions?include=all

Example Response Payload

{
            "actionName": "CreateAppointment",
            "actionType": "CreateRelatedObject",
            "taskFlowReference": "/WEB-INF/oracle/apps/crmCommon/activities/publicUi/activityManagement/fuse/flow/ZmmFuseActivityCreateTF.xml#ZmmFuseActivityCreateTF",
            "functionalPermission": null,
            "methodPermissions": [
                {
                    "methodPermission": "oracle.apps.customerCenter.infrastructure360.publicUi.bean.ZcmSecurityBean.updateSalesOrganization"
                }
            ],
            "privileges": [
                {
                    "privilege": "ZCM_MANAGE_SALES_PARTY_DATA"
                },
                {
                    "privilege": "ZCM_UPDATE_SALES_PARTY_DATA"
                }
            ],
            "parameters": {
                "ActivityFunctionCode": "APPOINTMENT",
                "ActivityOptionsParamsMap": {
                    "ElasticSearchNav": "Y",
                    "TFNav": "Y"
                },
                "requiresTaskflowReturn": true,
                "ActivityCreateParamsMap": {
                    "ActivityFunctionCode": "APPOINTMENT",
                    "AccountId": null
                }
            },
            "localizedName": "Action.CreateAppointment1",
            "localizedDescription": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/searchResources/11.13.18.05/entities/Account/actions/CreateAppointment?metaModelUuid=a8e5d34e-b9d8-4f59-8fe5-8fb2eb730974&include=all",
                    "kind": "item",
                    "name": "self"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/searchResources/11.13.18.05/entities/Account/actions/CreateAppointment?metaModelUuid=a8e5d34e-b9d8-4f59-8fe5-8fb2eb730974&include=all",
                    "kind": "item",
                    "name": "canonical"
                },
                {
                    "rel": "parent",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/searchResources/11.13.18.05/entities/Account/actions?metaModelUuid=a8e5d34e-b9d8-4f59-8fe5-8fb2eb730974&include=all",
                    "kind": "collection",
                    "name": "parent"
                }
            ]
        },
...
}

Search Operators

Retrieves a list of supported search operators.

cURL Command

https://servername.fa.us2.oraclecloud.com/crmRestApi/searchResources/11.13.18.05/searchOperators&limit=4

Example Response Payload

{
    "items": [
        {
            "searchOperatorUuid": "0497526d-bfd2-42f4-ab6a-ba2f58c6d72c",
            "searchOperatorName": "In",
            "mnemonic": "$in",
            "numberOfArguments": 1,
            "isApplicableForRequiredFields": true,
            "isApplicableToAllFields": false,
            "isApplcableToRecordSetFields": false,
            "isEnabled": true,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/searchResources/11.13.18.05/searchOperators/0497526d-bfd2-42f4-ab6a-ba2f58c6d72c",
                    "kind": "item",
                    "name": "self"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/searchResources/11.13.18.05/searchOperators/0497526d-bfd2-42f4-ab6a-ba2f58c6d72c",
                    "kind": "item",
                    "name": "canonical"
                },
                {
                    "rel": "parent",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/searchResources/11.13.18.05/searchOperators",
                    "kind": "collection",
                    "name": "parent"
                }
            ]
        },
...
}