Get a keyterm
get
/api/boss/data/objects/ora/cxSalesCommon/keyterms/v1/keyterms/{keyterms_id}
Request
Path Parameters
-
keyterms_id(required): string
This path parameter maps to the following field defined in the Key Terms REST resource:
- code
Query Parameters
-
$effectiveDate: string(date)
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.
-
$fields: string
Restricts the resource fields. Only the specified fields and mandatory system fields are returned.
There's no request body for this operation.
Back to TopResponse
Default Response
A single item response
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
-
object
oraCxSalesCommonKeyterms.Keyterm_item-fields
-
object
Key Term
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 : oraCxSalesCommonKeyterms.Keyterm_item-fields
Type:
Show Source
object
-
activeFlag: boolean
Title:
Status
Default Value:true
-
code: string
Title:
Code
-
createdBy: string
Title:
Created By
Read Only:true
-
group:
group
-
name: string
Title:
Name
-
outputType:
outputType
-
timeCreated: string
(date-time)
Title:
Created On
Read Only:true
-
timeUpdated: string
(date-time)
Title:
Last Updated Date
Read Only:true
-
updatedBy: string
Title:
Last Updated By
Read Only:true
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 : oraCommonAppsInfraObjects.LookupCode_abstract-item
Type:
Show Source
object
-
$sourceLang: string
Read Only:
true
-
createdBy: string
Read Only:
true
-
description: string
Read Only:
true
-
displaySequence: string
(big-integer)
Read Only:
true
-
enabledFlag: boolean
Read Only:
true
-
endDateActive: string
(date)
Read Only:
true
-
lookupCategoryId: string
(big-integer)
Read Only:
true
-
lookupCode: string
Read Only:
true
-
lookupType: string
Read Only:
true
-
meaning: string
Read Only:
true
-
startDateActive: string
(date)
Read Only:
true
-
tag: string
Read Only:
true
-
timeCreated: string
(date-time)
Read Only:
true
-
timeUpdated: string
(date-time)
Read Only:
true
-
updatedBy: string
Read Only:
true
Nested Schema : oraCxSalesCommonKeyterms.KeytermGroupLookup_item-fields-allOf[1]
Type:
Show Source
object
-
createdBy: string
Title:
Created By
The user who created the record. -
description: string
Title:
Lookup Code Description
The translated description of the Lookup Code. -
displaySequence: string
Title:
Display Sequence
The display sequence of the Lookup Code. -
enabledFlag: boolean
Title:
Lookup Code Enabled
The enabled flag of the Lookup Code. -
endDateActive: string
Title:
End Date Active
The active end date of the Lookup Code. -
lookupCategoryId: string
Title:
Lookup Category
The lookup category of the Lookup Code. -
lookupCode: string
Title:
Lookup Code ID
The unique identifier of the Lookup Code. -
lookupType: string
Title:
Lookup Type ID
The unique identifier of the Lookup Type. -
meaning: string
Title:
Lookup Code Meaning
The translated meaning of the Lookup Code. -
startDateActive: string
Title:
Start Date Active
The active start date of the Lookup Code. -
tag: string
Title:
Lookup Tag
The tag value of the Lookup Code. -
timeCreated: string
Title:
Created On
The date and time when the record was created. -
timeUpdated: string
Title:
Last Updated Date
The date and time when the record was last updated. -
updatedBy: string
Title:
Last Updated By
The user who last updated the record.
Nested Schema : Group
Type:
object
Title:
Group
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
-
object
oraCxSalesCommonKeyterms.KeytermPrompt_item-fields
-
object
Key Term Prompt
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 : oraCxSalesCommonKeyterms.KeytermPrompt_item-fields
Type:
Show Source
object
-
createdBy: string
Title:
Created By
Read Only:true
-
description: string
Title:
Description
-
id: string
(big-integer)
Read Only:
true
-
keyterm:
keyterm
-
latestAdditionalInstructions: string
-
name: string
Title:
Name
-
status:
status
-
text: string
Title:
Prompt
-
timeCreated: string
(date-time)
Title:
Created On
Read Only:true
-
timeUpdated: string
(date-time)
Title:
Last Updated Date
Read Only:true
-
updatedBy: string
Title:
Last Updated By
Read Only:true
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 : keyterm-allOf[2]
Type:
object
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
-
allOf
oraCxSalesCommonKeyterms.KeytermFileAttachment_item-fields
-
object
Prompt Test File
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 : oraCxSalesCommonKeyterms.KeytermFileAttachment_item-fields-allOf[0]
Type:
Show Source
object
Nested Schema : oraCommonAppsInfraAttachments.Attachment_abstract-item
Type:
Show Source
object
-
createdBy: string
Read Only:
true
-
document:
document
-
id: string
(big-integer)
Read Only:
true
-
timeCreated: string
(date-time)
Read Only:
true
-
timeUpdated: string
(date-time)
Read Only:
true
-
updatedBy: string
Read Only:
true
Nested Schema : oraCxSalesCommonKeyterms.KeytermFileAttachment_item-fields-allOf[2]
Type:
Show Source
object
-
createdBy: string
Title:
Created By
The user who created the record. -
id: string
Title:
Attachment ID
The unique identifier of the attachment. -
timeCreated: string
Title:
Created On
The date and time when the record was created. -
timeUpdated: string
Title:
Last Updated Date
The date and time when the record was last updated. -
updatedBy: string
Title:
Last Updated By
The user who last updated the record.
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 : document
Match All
The name of the accessor used to retrieve the document.
Show Source
-
allOf
oraCommonAppsInfraAttachments.Document_item-fields
-
object
__busObj_context
-
object
Document Accessor
Title:
Document Accessor
The name of the accessor used to retrieve the document.
Nested Schema : oraCommonAppsInfraAttachments.Document_abstract-item
Type:
Show Source
object
-
$sourceLang: string
Read Only:
true
-
chunkingDirectives: object
chunkingDirectives
-
contentEndpoint: string
Read Only:
true
-
createdBy: string
Read Only:
true
-
description: string
-
downloadParameters: object
downloadParameters
-
fileName: string
-
id: string
(big-integer)
Read Only:
true
-
latestDocument:
latestDocument
-
managedEndpointKey: string
-
managedPath: string
-
managedUrl: string
Read Only:
true
-
mediaType: string
-
name: string
-
securityGroup: string
Read Only:
true
-
size: string
(big-integer)
-
timeCreated: string
(date-time)
Read Only:
true
-
timeUpdated: string
(date-time)
Read Only:
true
-
title: string
-
type:
type
-
updatedBy: string
Read Only:
true
-
uploadParameters: object
uploadParameters
-
url: string
-
version: string
Nested Schema : oraCommonAppsInfraAttachments.Document_item-fields-allOf[1]
Type:
Show Source
object
-
chunkingDirectives: object
Document
Title:
Document
Directives for customers uploading chunked files. -
contentEndpoint: string
Title:
Server Endpoint
Endpoint for the content server. -
createdBy: string
Title:
Created By
The user who created the record. -
description: string
Title:
Description
The description of the document. -
downloadParameters: object
Download Parameters
Title:
Download Parameters
Used to get the parameters required to download a file type document. -
fileName: string
Title:
File Name
The file name of a file type document. -
id: string
Title:
Document ID
The unique identifier of the document. -
managedEndpointKey: string
Title:
Endpoint Key
The endpoint key from topology manager. -
managedPath: string
Title:
Path
The relative path of the managed URL. -
managedUrl: string
Title:
Managed URL
The URL that's a combination of the managed endpoint and path. -
mediaType: string
Title:
Media Type
The media type of a file type document. -
name: string
Title:
Name
The name that identifies a file type of the stored document. -
securityGroup: string
Title:
Security Group
Used to get the group where the file type documents are organized. -
size: string
Title:
Size
The size of a file type document. -
timeCreated: string
Title:
Created On
The date and time when the record was created. -
timeUpdated: string
Title:
Last Updated Date
The date and time when the record was last updated. -
title: string
Title:
Title
The title of the document. -
type: string
Title:
Type
The type of document. -
updatedBy: string
Title:
Last Updated By
The user who last updated the record. -
uploadParameters: object
Upload Parameters
Title:
Upload Parameters
Used to get the parameters required to upload a file type document. -
url: string
Title:
URL
The URL of a web page type document. -
version: string
Title:
Version
The version of a file type document.
Nested Schema : Document Accessor
Type:
object
Title:
Document Accessor
The name of the accessor used to retrieve the document.
Nested Schema : latestDocument
Match All
The latest version of the attached document.
Show Source
-
allOf
oraCommonAppsInfraAttachments.Document_item-fields
-
object
__busObj_context
-
object
Latest Document
Title:
Latest Document
The latest version of the attached document.
Nested Schema : chunkCount
Match All
The required number of chunked files to be uploaded to the content server.
Show Source
-
string(big-integer)
-
string
Title:
Document
The required number of chunked files to be uploaded to the content server.
Nested Schema : chunkSize
Match All
The required size of each chunked file to be uploaded to the content server.
Show Source
-
string(big-integer)
-
string
Title:
Document
The required size of each chunked file to be uploaded to the content server.
Nested Schema : prefix
Match All
The prefix used in the file names of the chunked files.
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 : 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
-
object
oraCxSalesCommonKeyterms.PromptTestResult_item-fields
-
object
Prompt Test Result
Title:
Prompt Test Result
Prompt test result includes information about the response provided by the large language model for a specific prompt.
Nested Schema : oraCxSalesCommonKeyterms.PromptTestResult_item-fields
Type:
Show Source
object
-
additionalInstructions: string
Title:
Additional Instruction
-
createdBy: string
Title:
Created By
Read Only:true
-
id: string
(big-integer)
Read Only:
true
-
prompt:
prompt
-
promptText: string
Title:
Prompt
-
resultDate: string
(date-time)
Title:
Date
-
submitDate: string
(date-time)
Title:
Upload Date
-
testOutput: string
Title:
Response
-
timeCreated: string
(date-time)
Title:
Created On
Read Only:true
-
timeUpdated: string
(date-time)
Title:
Last Updated Date
Read Only:true
-
updatedBy: string
Title:
Last Updated By
Read Only:true
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 : prompt-allOf[2]
Type:
object
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
-
object
oraCxSalesCommonKeyterms.PromptTestCitation_item-fields
-
object
Citation
Title:
Citation
Citation is the part of the source document that's referenced by the large language model to get a response.
Nested Schema : oraCxSalesCommonKeyterms.PromptTestCitation_item-fields
Type:
Show Source
object
-
citation: string
-
createdBy: string
Title:
Created By
Read Only:true
-
id: string
(big-integer)
Read Only:
true
-
sequenceNumber: string
-
testResult:
testResult
-
timeCreated: string
(date-time)
Title:
Created On
Read Only:true
-
timeUpdated: string
(date-time)
Title:
Last Updated Date
Read Only:true
-
updatedBy: string
Title:
Last Updated By
Read Only:true
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-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
-
object
oraCxSalesCommonKeyterms.KeytermFile_item-fields
-
object
Key Term File
Title:
Key Term File
Key term file is the contract document that's used in prompt testing.
Nested Schema : oraCxSalesCommonKeyterms.KeytermFile_item-fields
Type:
Show Source
object
-
attachment:
attachment
-
createdBy: string
Title:
Created By
Read Only:true
-
documentIdentifier: string
-
id: string
(big-integer)
Read Only:
true
-
parentType:
parentType
-
timeCreated: string
(date-time)
Title:
Created On
Read Only:true
-
timeUpdated: string
(date-time)
Title:
Last Updated Date
Read Only:true
-
updatedBy: string
Title:
Last Updated By
Read Only:true
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-allOf[2]
Type:
object
Links
- group
-
Parameters:
- keytermGroups_id:
$response.body#/group/$id
- keytermGroups_id:
- self
-
Parameters:
- keyterms_id:
$request.path.keyterms_id
- keyterms_id:
Examples
The following example shows how to get a keyterm by submitting a get 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/{keyterms_id}'
\ --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.
{ "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" } } } } }