1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Key Terms v1
  4. Prompts v1
  5. Test Results v1
  6. Keyterm Files v1

Get a keyterms file for a key term prompts test result using advanced query

post

/api/boss/data/objects/ora/cxSalesCommon/keyterms/v1/keyterms/{keyterms_id}/prompts/{keyterms-prompts_id}/testResults/{keyterms-prompts-testResults_id}/keytermFile/{keyterms-prompts-testResults-keytermFile_id}/$query

Request

Path Parameters
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
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 : 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.
Back to Top

Response

Default Response

A single item response
Body ()
Root Schema : keyterms-prompts-testResults-keytermFile_item-response
Match All
Show Source
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 : __busObj_context
Type: object
Show Source
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 : 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 : attachment-allOf[2]
Type: object
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 : $context
Type: object
Show Source
Nested Schema : links
Type: object
Read Only: true
Show Source
Nested Schema : $self
Type: object
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
Links
self
Parameters:
  • keyterms-prompts-testResults-keytermFile_id: $request.path.keyterms-prompts-testResults-keytermFile_id
  • keyterms-prompts-testResults_id: $request.path.keyterms-prompts-testResults_id
  • keyterms-prompts_id: $request.path.keyterms-prompts_id
  • keyterms_id: $request.path.keyterms_id
Back to Top

Examples

The following example shows how to advanced query all keyterm files for a key term prompts test result by submitting a post request on the REST resource using cURL.

cURL Command

curl -X POST --location 'https://<servername>/api/boss/data/objects/ora/cxSalesCommon/keyterms/v1/$en/keyterms/{keyterms_id}/prompts/{keyterms-prompts_id}/testResults/{keyterms-prompts-testResults_id}/keytermFile/{keyterms-prompts-testResults-keytermFile_id}/$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.

{
    "fields": [
        "id",
        "parentType",
        "documentIdentifier",
        "createdBy",
        "timeCreated",
        "updatedBy",
        "timeUpdated"
    ],
    "accessors": {
        "attachment": {
            "accessors": {
                "document": {
                    "fields": [
                        "id",
                        "title",
                        "description",
                        "fileName",
                        "mediaType"
                    ]
                }
            },
            "fields": [
                "id",
                "category",
                "timeUpdated"
            ]
        }
    }
}

Example of Response Body

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

{
    "items": [
        {
            "id": "300100626058686",
            "parentType": "OKC_PROMPT_TEST_RESULT",
            "documentIdentifier": "00020000000EACED00057708000110F09F368DBC0000000EACED00057708000110F09F368DBB",
            "createdBy": "CONMGR",
            "timeCreated": "2025-01-15T10:11:06.458829Z",
            "updatedBy": "CONMGR",
            "timeUpdated": "2025-01-15T10:11:06.458829Z",
            "$id": "300100626058686",
            "$context": {
                "etag": "1",
                "links": {
                    "$self": {
                        "href": "https://cptbbybqy-test.fusionapps.ocs.oc-test.com:443/api/boss/data/objects/ora/cxSalesCommon/keyterms/v1/$en/keyterms/ATS_JLSA_Renewal_Cap_Percentage/prompts/300100626058682/testResults/300100626058685/keytermFile/300100626058686"
                    }
                }
            },
            "attachment": {
                "id": "300100626058684",
                "category": "MISC",
                "timeUpdated": "2025-01-15T10:07:20.361289Z",
                "$id": "300100626058684",
                "document": {
                    "id": "300100626058683",
                    "title": "Sample Oracle Contract-1-1",
                    "description": "Sample Oracle Contract-1-1.pdf",
                    "fileName": "Sample Oracle Contract_1_1.pdf",
                    "mediaType": "application/pdf",
                    "$id": "300100626058683"
                }
            }
        }
    ],
    "hasMore": false
}
Back to Top