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

Get all keyterms using advanced query

post

/api/boss/data/objects/ora/cxSalesCommon/keyterms/v1/keyterms/$query

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.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Match All
Show Source
Nested Schema : __collection_query
Match All
Show Source
Nested Schema : schema
Type: object
Show Source
  • accessors
    Maps accessor names to query objects specific to corresponding accessors. Query object for each accessor supports query capabilities similar to the base.
  • fields
    Restricts the resource fields. Only the specified fields and mandatory system fields are returned.
  • subTypes
    Maps discriminator values (as defined in subtypes) to query objects specific to corresponding subtypes. Subtype-specific query objects support a subset(fields,accessors,filter) of the query capabilities when compared to the base.
Nested Schema : __collection_query-allOf[1]
Type: object
Show Source
Nested Schema : type
Type: object
Show Source
Nested Schema : accessors
Type: object
Maps accessor names to query objects specific to corresponding accessors. Query object for each accessor supports query capabilities similar to the base.
Nested Schema : fields
Type: array
Restricts the resource fields. Only the specified fields and mandatory system fields are returned.
Show Source
Nested Schema : subTypes
Type: object
Maps discriminator values (as defined in subtypes) to query objects specific to corresponding subtypes. Subtype-specific query objects support a subset(fields,accessors,filter) of the query capabilities when compared to the base.
Nested Schema : collection
Type: object
Defines query criteria that can be applied on a resource collection.
Show Source
  • The resource collection will be queried using the specified filter condition.
  • 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.
  • Defines the starting position of the resource collection. If offset exceeds the resource count then no resource items are returned.
  • Represents the privilege or action required to check for while serving a request to access a resource.
  • sortBy
    Orders a resource collection based on the specified fields.
Nested Schema : sortBy
Type: array
Orders a resource collection based on the specified fields.
Show Source
Nested Schema : items
Match One Schema
Show Source
  • Name of field based on which sorting will happen. Order is ascending.
  • items-oneOf[1]
    Object with single entry. Key must be name of field based on which sorting will happen. Value must be either asc or desc to decide the sort order.
Nested Schema : items-oneOf[1]
Type: object
Object with single entry. Key must be name of field based on which sorting will happen. Value must be either asc or desc to decide the sort order.
Nested Schema : parameters
Type: object
Values to be applied in a parameterized filter specific to the view.
Back to Top

Response

Default Response

An array of items response
Body ()
Root Schema : keyterms_view-default
Match All
Show Source
Nested Schema : __collection_context
Type: object
Show Source
Nested Schema : keyterms_view-default-allOf[1]
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : keyterms_item-response
Match All
Show Source
Nested Schema : oraCxSalesCommonKeyterms.Keyterm_item
Match All
Key term is the metadata present in the contract documents. The key terms to be extracted for each contract type is defined in the application with the corresponding prompts to be used for extraction.
Show Source
Nested Schema : oraCxSalesCommonKeyterms.Keyterm_item-fields
Type: object
Show Source
Nested Schema : Key Term
Type: object
Title: Key Term
Key term is the metadata present in the contract documents. The key terms to be extracted for each contract type is defined in the application with the corresponding prompts to be used for extraction.
Nested Schema : __busObj_context
Type: object
Show Source
Nested Schema : keyterms_item-response-allOf[2]
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 : oraCxSalesCommonKeyterms.KeytermGroupLookup_item-fields
Match All
Show Source
Nested Schema : oraCommonAppsInfraObjects.LookupCode_abstract-item
Type: object
Show Source
Nested Schema : oraCxSalesCommonKeyterms.KeytermGroupLookup_item-fields-allOf[1]
Type: object
Show Source
Nested Schema : Group
Type: object
Title: Group
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 : keyterms-prompts
Match All
Show Source
Nested Schema : keyterms-prompts-allOf[1]
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : keyterms-prompts_item-response
Match All
Show Source
Nested Schema : oraCxSalesCommonKeyterms.KeytermPrompt_item
Match All
Key term prompt is the question that's used in a large language model to extract a certain key term from contract documents.
Show Source
Nested Schema : oraCxSalesCommonKeyterms.KeytermPrompt_item-fields
Type: object
Show Source
Nested Schema : Key Term Prompt
Type: object
Title: Key Term Prompt
Key term prompt is the question that's used in a large language model to extract a certain key term from contract documents.
Nested Schema : keyterms-prompts_item-response-allOf[2]
Type: object
Show Source
Nested Schema : keyterm
Match All
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" ]
Nested Schema : keyterm-allOf[2]
Type: object
Nested Schema : keyterms-prompts-_attachments
Match All
Show Source
Nested Schema : keyterms-prompts-testResults
Match All
Show Source
Nested Schema : keyterms-prompts-_attachments-allOf[1]
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : keyterms-prompts-_attachments_item-response
Match All
Show Source
Nested Schema : oraCxSalesCommonKeyterms.KeytermFileAttachment_item
Match All
Prompt test file is a file that's used for testing prompts and extracting key terms from contract documents.
Show Source
Nested Schema : oraCxSalesCommonKeyterms.KeytermFileAttachment_item-fields
Match All
Show Source
Nested Schema : oraCxSalesCommonKeyterms.KeytermFileAttachment_item-fields-allOf[0]
Type: object
Show Source
Nested Schema : oraCommonAppsInfraAttachments.Attachment_abstract-item
Type: object
Show Source
Nested Schema : oraCxSalesCommonKeyterms.KeytermFileAttachment_item-fields-allOf[2]
Type: object
Show Source
Nested Schema : Prompt Test File
Type: object
Title: Prompt Test File
Prompt test file is a file that's used for testing prompts and extracting key terms from contract documents.
Nested Schema : category
Match All
Attachment Category
Show Source
  • Title: Category
    Default Value: MISC
    Attachment Category
  • Allowed Values: [ "MISC" ]
Nested Schema : document
Match All
The name of the accessor used to retrieve the document.
Show Source
Nested Schema : oraCommonAppsInfraAttachments.Document_item-fields
Match All
Show Source
Nested Schema : oraCommonAppsInfraAttachments.Document_abstract-item
Type: object
Show Source
Nested Schema : oraCommonAppsInfraAttachments.Document_item-fields-allOf[1]
Type: object
Show Source
Nested Schema : Document Accessor
Type: object
Title: Document Accessor
The name of the accessor used to retrieve the document.
Nested Schema : chunkingDirectives
Type: object
Show Source
Nested Schema : downloadParameters
Type: object
Show Source
Nested Schema : latestDocument
Match All
The latest version of the attached document.
Show Source
Nested Schema : type
Match All
Show Source
  • Allowed Values: [ "FILE", "WEB_PAGE", "TMURI", "TEXT" ]
Nested Schema : uploadParameters
Type: object
Show Source
Nested Schema : chunkCount
Match All
The required number of chunked files to be uploaded to the content server.
Show Source
Nested Schema : chunkSize
Match All
The required size of each chunked file to be uploaded to the content server.
Show Source
Nested Schema : prefix
Match All
The prefix used in the file names of the chunked files.
Show Source
  • Title: Document
    The prefix used in the file names of the chunked files.
Nested Schema : version
Match All
Show Source
Nested Schema : XFND_CERT_FP
Match All
Show Source
Nested Schema : XFND_EXPIRES
Match All
Show Source
Nested Schema : XFND_RANDOM
Match All
Show Source
Nested Schema : XFND_SCHEME_ID
Match All
Show Source
Nested Schema : XFND_SIGNATURE
Match All
Show Source
Nested Schema : Latest Document
Type: object
Title: Latest Document
The latest version of the attached document.
Nested Schema : Document
Type: object
Title: Document
Directives for customers uploading chunked files.
Nested Schema : Download Parameters
Type: object
Title: Download Parameters
Used to get the parameters required to download a file type document.
Nested Schema : Upload Parameters
Type: object
Title: Upload Parameters
Used to get the parameters required to upload a file type document.
Nested Schema : XFND_CERT_FP
Match All
Show Source
Nested Schema : XFND_EXPIRES
Match All
Show Source
Nested Schema : XFND_RANDOM
Match All
Show Source
Nested Schema : XFND_SCHEME_ID
Match All
Show Source
Nested Schema : XFND_SIGNATURE
Match All
Show Source
Nested Schema : keyterms-prompts-testResults-allOf[1]
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : keyterms-prompts-testResults_item-response
Match All
Show Source
Nested Schema : oraCxSalesCommonKeyterms.PromptTestResult_item
Match All
Prompt test result includes information about the response provided by the large language model for a specific prompt.
Show Source
Nested Schema : oraCxSalesCommonKeyterms.PromptTestResult_item-fields
Type: object
Show Source
Nested Schema : Prompt Test Result
Type: object
Title: Prompt Test Result
Prompt test result includes information about the response provided by the large language model for a specific prompt.
Nested Schema : keyterms-prompts-testResults_item-response-allOf[2]
Type: object
Show Source
Nested Schema : prompt
Match All
Show Source
Nested Schema : prompt-allOf[2]
Type: object
Nested Schema : keyterms-prompts-testResults-citations
Match All
Show Source
Nested Schema : keyterms-prompts-testResults-keytermFile_item-response
Match All
Show Source
Nested Schema : keyterms-prompts-testResults-citations-allOf[1]
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : keyterms-prompts-testResults-citations_item-response
Match All
Show Source
Nested Schema : oraCxSalesCommonKeyterms.PromptTestCitation_item
Match All
Citation is the part of the source document that's referenced by the large language model to get a response.
Show Source
Nested Schema : oraCxSalesCommonKeyterms.PromptTestCitation_item-fields
Type: object
Show Source
Nested Schema : Citation
Type: object
Title: Citation
Citation is the part of the source document that's referenced by the large language model to get a response.
Nested Schema : testResult
Match All
Show Source
Nested Schema : testResult-allOf[2]
Type: object
Nested Schema : oraCxSalesCommonKeyterms.KeytermFile_item
Match All
Key term file is the contract document that's used in prompt testing.
Show Source
Nested Schema : oraCxSalesCommonKeyterms.KeytermFile_item-fields
Type: object
Show Source
Nested Schema : Key Term File
Type: object
Title: Key Term File
Key term file is the contract document that's used in prompt testing.
Nested Schema : attachment
Match All
Show Source
Nested Schema : parentType
Match All
Show Source
  • Default Value: OKC_PROMPT_TEST_RESULT
  • Allowed Values: [ "OKC_PROMPT_TEST_RESULT", "OKC_K_KEY_TERMS" ]
Nested Schema : attachment-allOf[2]
Type: object
Back to Top

Examples

The following example shows how to create an advanced query to get all keyterms by submitting a post request on the REST resource using cURL.

cURL Command

curl -X POST --location 'https://servername.fa.us2.oraclecloud.com/api/boss/data/objects/ora/cxSalesCommon/keyterms/v1/keyterms/$query' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer <token>' \ --D @request.json

Example of Request Body

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

{
    "accessors": {
        "prompts": {
            "fields": [
                "id",
                "name",
                "description",
                "text",
                "status",
                "createdBy"
            ]
        },
        "group": {
            "fields": [
                "lookupType",
                "lookupCode",
                "meaning",
                "description"
            ]
        }
    },
    "fields": [
        "code",
        "name",
        "outputType",
        "activeFlag"
    ]

Example of Response Body

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

{
    "items": [
    {
            "code": "Audit_Rights",
            "name": "Audit Rights",
            "outputType": "ORA_OKC_TEXT",
            "activeFlag": true,
            "$id": "Audit_Rights",
            "$context": {
                "etag": "5",
                "links": {
                    "$self": {
                        "href": "https://servername.fa.us2.oraclecloud.com/api/boss/data/objects/ora/cxSalesCommon/keyterms/v1/$en/keyterms/Audit_Rights"
                    }
                }
            },
            "prompts": {
                "items": [
                    {
                        "id": "300100626242100",
                        "name": "Audit Rights",
                        "description": null,
                        "text": "Is there a clause related to audit in the contract document?",
                        "status": "ORA_OKC_ACTIVE",
                        "createdBy": "CONMGR",
                        "$id": "300100626242100",
                        "$context": {
                            "etag": "7",
                            "links": {
                                "$self": {
                                    "href": "https://servername.fa.us2.oraclecloud.com/api/boss/data/objects/ora/cxSalesCommon/keyterms/v1/$en/keyterms/Audit_Rights/prompts/300100626242100"
                                }
                            }
                        }
                    }
                ],
                "hasMore": false
            },
            "group": {
                "lookupType": "ORA_OKC_KEY_TERM_GROUP",
                "lookupCode": "ATS_OKC_Legal",
                "meaning": "Legal",
                "description": null,
                "$id": "ORA_OKC_KEY_TERM_GROUP,ATS_OKC_Legal",
                "$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_Legal"
                        }
                    }
                }
            }
    },
    {
            "code": "Limitation_Of_Liability",
            "name": "Limitation Of Liability",
            "outputType": "ORA_OKC_TEXT",
            "activeFlag": true,
            "$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"
                    }
                }
            },
            "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
            },
            "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"
                        }
                    }
                }
            }
        }
    ]
}
Back to Top