1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Key Terms v1

Get all details for all keyterms

get

/api/boss/data/objects/ora/cxSalesCommon/keyterms/v1/keyterms/$views/KeytermDetails

Request

Query Parameters
  • The effective date value in ISO 8601 date format 'YYYY-MM-DD'. This date is required by business logic to search for effective-dated business objects.
  • Restricts the resource fields. Only the specified fields and mandatory system fields are returned.
  • The resource collection will be queried using the specified filter condition.
  • Specifies whether the server should estimate the total number of records for a given query and include the count in the response.
  • Restricts the number of resource items returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resource items.
    Default Value: 25
  • Defines the starting position of the resource collection. If offset exceeds the resource count then no resource items are returned.
    Default Value: 0
  • Orders a resource collection based on the specified fields. The parameter value is a comma-separated string of field names, each optionally followed by a colon and "asc" (default) or "desc".

There's no request body for this operation.

Back to Top

Response

Default Response

Successful response of retrieving view KeytermDetails for resource Key Terms
Body ()
Root Schema : keyterms_view-KeytermDetails
Match All
Show Source
Nested Schema : __collection_context
Type: object
Show Source
Nested Schema : keyterms_view-KeytermDetails-allOf[1]
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : items
Match All
Show Source
Nested Schema : items-allOf[0]
Match All
Show Source
Nested Schema : __busObj_context
Type: object
Show Source
Nested Schema : items-allOf[0]-allOf[1]
Type: object
Show Source
Nested Schema : items-allOf[1]
Type: object
Nested Schema : $context
Type: object
Show Source
Nested Schema : links
Type: object
Read Only: true
Show Source
Nested Schema : $self
Type: object
Show Source
Nested Schema : group
Match All
Show Source
Nested Schema : outputType
Match All
Show Source
  • Title: Output Type
  • Allowed Values: [ "ORA_OKC_TEXT", "ORA_OKC_NUMBER", "ORA_OKC_DATE" ]
Nested Schema : prompts
Match All
Show Source
Nested Schema : group-allOf[1]
Type: object
Show Source
Nested Schema : description
Match All
Show Source
  • Read Only: true
  • Title: Lookup Code Description
    The translated description of the Lookup Code.
Nested Schema : lookupCode
Match All
Show Source
  • Read Only: true
  • Title: Lookup Code ID
    The unique identifier of the Lookup Code.
Nested Schema : lookupType
Match All
Show Source
  • Read Only: true
  • Title: Lookup Type ID
    The unique identifier of the Lookup Type.
Nested Schema : meaning
Match All
Show Source
  • Read Only: true
  • Title: Lookup Code Meaning
    The translated meaning of the Lookup Code.
Nested Schema : prompts-allOf[1]
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : items
Match All
Show Source
Nested Schema : items-allOf[1]
Type: object
Show Source
Nested Schema : status
Match All
Show Source
  • Title: Status
    Default Value: ORA_OKC_DRAFT
  • Allowed Values: [ "ORA_OKC_DRAFT", "ORA_OKC_ACTIVE", "ORA_OKC_INACTIVE" ]
Back to Top

Examples

The following example shows how to get all details for all keyterms by submitting a post request on the REST resource using cURL.

cURL Command

curl -X GET --location 'https://servername.fa.us2.oraclecloud.com/api/boss/data/objects/ora/cxSalesCommon/keyterms/v1/$en/keyterms/$views/KeytermDetails' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer <token>'

Example of Response Body

The following shows an example of the response body in JSON format.

{
    "items": [
    	{
            "code": "Limitation_Of_Liability",
            "name": "Limitation Of Liability",
            "outputType": "ORA_OKC_TEXT",
            "activeFlag": true,
            "createdBy": "CONMGR",
            "timeCreated": "2025-01-13T19:43:15.508165Z",
            "updatedBy": "CONMGR",
            "timeUpdated": "2025-01-13T19:44:26.919026Z",
            "$id": "Limitation_Of_Liability",
            "$context": {
                "etag": "3",
                "links": {
                    "$self": {
                        "href": "https://servername.fa.us2.oraclecloud.com/api/boss/data/objects/ora/cxSalesCommon/keyterms/v1/$en/keyterms/Limitation_Of_Liability"
                    }
                }
            },
            "group": {
                "lookupType": "ORA_OKC_KEY_TERM_GROUP",
                "lookupCode": "ATS_OKC_Operations",
                "meaning": "Operations",
                "description": null,
                "$id": "ORA_OKC_KEY_TERM_GROUP,ATS_OKC_Operations",
                "$context": {
                    "links": {
                        "$self": {
                            "href": "https://servername.fa.us2.oraclecloud.com/api/boss/data/objects/ora/cxSalesCommon/keyterms/v1/$en/keytermGroups/ORA_OKC_KEY_TERM_GROUP%2CATS_OKC_Operations"
                        }
                    }
                }
            },
            "prompts": {
                "items": [
                    {
                        "id": "300100625947666",
                        "name": "Limitation Of Liability",
                        "description": null,
                        "text": "Is there a clause related to limitation of liability mentioned in the document?",
                        "status": "ORA_OKC_ACTIVE",
                        "createdBy": "CONMGR",
                        "$id": "300100625947666",
                        "$context": {
                            "etag": "4",
                            "links": {
                                "$self": {
                                    "href": "https://servername.fa.us2.oraclecloud.com/api/boss/data/objects/ora/cxSalesCommon/keyterms/v1/$en/keyterms/Limitation_Of_Liability/prompts/300100625947666"
                                }
                            }
                        }
                    }
                ],
                "hasMore": false
            }
        },
        {
            "code": "Recovery_Time_Objective",
            "name": "Recovery Time Objective",
            "outputType": "ORA_OKC_TEXT",
            "activeFlag": true,
            "createdBy": "CONMGR",
            "timeCreated": "2025-01-13T19:45:38.009342Z",
            "updatedBy": "CONMGR",
            "timeUpdated": "2025-01-13T19:47:06.931608Z",
            "$id": "Recovery_Time_Objective",
            "$context": {
                "etag": "3",
                "links": {
                    "$self": {
                        "href": "https://servername.fa.us2.oraclecloud.com/api/boss/data/objects/ora/cxSalesCommon/keyterms/v1/$en/keyterms/Recovery_Time_Objective"
                    }
                }
            },
            "group": {
                "lookupType": "ORA_OKC_KEY_TERM_GROUP",
                "lookupCode": "ATS_OKC_Operations",
                "meaning": "Operations",
                "description": null,
                "$id": "ORA_OKC_KEY_TERM_GROUP,ATS_OKC_Operations",
                "$context": {
                    "links": {
                        "$self": {
                            "href": "https://servername.fa.us2.oraclecloud.com/api/boss/data/objects/ora/cxSalesCommon/keyterms/v1/$en/keytermGroups/ORA_OKC_KEY_TERM_GROUP%2CATS_OKC_Operations"
                        }
                    }
                }
            },
            "prompts": {
                "items": [
                    {
                        "id": "300100625947681",
                        "name": "Recovery Time Objective",
                        "description": null,
                        "text": "What is the Recovery Time Objective mentioned in the contract document?",
                        "status": "ORA_OKC_ACTIVE",
                        "createdBy": "CONMGR",
                        "$id": "300100625947681",
                        "$context": {
                            "etag": "5",
                            "links": {
                                "$self": {
                                    "href": "https://servername.fa.us2.oraclecloud.com/api/boss/data/objects/ora/cxSalesCommon/keyterms/v1/$en/keyterms/Recovery_Time_Objective/prompts/300100625947681"
                                }
                            }
                        }
                    }
                ],
                "hasMore": false
            }
        }
    ]
}
Back to Top