Jump to

• Request
• Response
• Examples

Create a citation for a keyterm prompt test result

post

/api/boss/data/objects/ora/cxSalesCommon/keyterms/v1/keyterms/{keyterms_id}/prompts/{keyterms-prompts_id}/testResults/{keyterms-prompts-testResults_id}/citations

Request

Path Parameters

• keyterms-prompts-testResults_id(required): string
  This path parameter maps to the following field defined in the Key Terms/prompts/testResults REST resource:
  

  1. id
• keyterms-prompts_id(required): string
  This path parameter maps to the following field defined in the Key Terms/prompts REST resource:
  

  1. id
• keyterms_id(required): string
  This path parameter maps to the following field defined in the Key Terms REST resource:
  

  1. code

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Match All

Show Source

• allOf oraCxSalesCommonKeyterms.PromptTestCitation_post-item
• object __busObj_context

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCxSalesCommonKeyterms.PromptTestCitation_post-item"
        },
        {
            "$ref":"#/components/schemas/__busObj_context"
        }
    ]
}

Nested Schema : oraCxSalesCommonKeyterms.PromptTestCitation_post-item

Match All

Show Source

• allOf oraCxSalesCommonKeyterms.PromptTestCitation_item
• object oraCxSalesCommonKeyterms.PromptTestCitation_post-item-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCxSalesCommonKeyterms.PromptTestCitation_item"
        },
        {
            "type":"object",
            "properties":{
                "testResult":{
                    "oneOf":[
                        {
                            "type":"object",
                            "properties":{
                                "id":{
                                    "$ref":"#/components/schemas/oraCxSalesCommonKeyterms.PromptTestResult_item-fields/properties/id"
                                }
                            }
                        },
                        {
                            "$ref":"#/components/schemas/__busObj_context"
                        }
                    ]
                }
            }
        }
    ],
    "required":[
        "sequenceNumber"
    ]
}

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.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCxSalesCommonKeyterms.PromptTestCitation_item-fields"
        },
        {
            "type":"object",
            "title":"Citation",
            "x-hints":{
                "titlePlural":"Citations"
            },
            "description":"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: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"big-integer",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "sequenceNumber":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true
        },
        "citation":{
            "type":"string",
            "nullable":true
        },
        "createdBy":{
            "type":"string",
            "x-searchable":true,
            "readOnly":true,
            "title":"Created By"
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "x-sortable":true,
            "readOnly":true,
            "title":"Created On"
        },
        "updatedBy":{
            "type":"string",
            "x-searchable":true,
            "readOnly":true,
            "title":"Last Updated By"
        },
        "timeUpdated":{
            "type":"string",
            "format":"date-time",
            "x-sortable":true,
            "readOnly":true,
            "title":"Last Updated Date"
        },
        "testResult":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/oraCxSalesCommonKeyterms.PromptTestResult_item"
                },
                {
                    "$ref":"#/components/schemas/__busObj_context"
                },
                {
                    "type":"object",
                    "x-searchable":true
                }
            ]
        }
    },
    "x-primaryKey":[
        "id"
    ]
}

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 : oraCxSalesCommonKeyterms.PromptTestCitation_post-item-allOf[1]

Type: object

Show Source

• testResult: testResult

{
    "type":"object",
    "properties":{
        "testResult":{
            "oneOf":[
                {
                    "type":"object",
                    "properties":{
                        "id":{
                            "$ref":"#/components/schemas/oraCxSalesCommonKeyterms.PromptTestResult_item-fields/properties/id"
                        }
                    }
                },
                {
                    "$ref":"#/components/schemas/__busObj_context"
                }
            ]
        }
    }
}

Nested Schema : __busObj_context

Type: object

Show Source

• $context: object $context
• $id: string

{
    "type":"object",
    "properties":{
        "$id":{
            "type":"string"
        },
        "$context":{
            "type":"object",
            "properties":{
                "etag":{
                    "type":"string"
                },
                "links":{
                    "type":"object",
                    "properties":{
                        "$self":{
                            "type":"object",
                            "properties":{
                                "href":{
                                    "type":"string"
                                }
                            }
                        }
                    },
                    "readOnly":true
                }
            }
        }
    }
}

Nested Schema : testResult

Match All

Show Source

• allOf oraCxSalesCommonKeyterms.PromptTestResult_item
• object __busObj_context
• object testResult-allOf[2]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCxSalesCommonKeyterms.PromptTestResult_item"
        },
        {
            "$ref":"#/components/schemas/__busObj_context"
        },
        {
            "type":"object",
            "x-searchable":true
        }
    ]
}

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.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCxSalesCommonKeyterms.PromptTestResult_item-fields"
        },
        {
            "type":"object",
            "title":"Prompt Test Result",
            "x-hints":{
                "titlePlural":"Prompt Test Results"
            },
            "description":"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: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"big-integer",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "promptText":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "title":"Prompt"
        },
        "additionalInstructions":{
            "type":"string",
            "nullable":true,
            "x-searchable":true,
            "title":"Additional Instruction"
        },
        "submitDate":{
            "type":"string",
            "format":"date-time",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "title":"Upload Date"
        },
        "resultDate":{
            "type":"string",
            "format":"date-time",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "title":"Date"
        },
        "testOutput":{
            "type":"string",
            "nullable":true,
            "x-sortable":true,
            "title":"Response"
        },
        "createdBy":{
            "type":"string",
            "x-searchable":true,
            "readOnly":true,
            "title":"Created By"
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "x-sortable":true,
            "readOnly":true,
            "title":"Created On"
        },
        "updatedBy":{
            "type":"string",
            "x-searchable":true,
            "readOnly":true,
            "title":"Last Updated By"
        },
        "timeUpdated":{
            "type":"string",
            "format":"date-time",
            "x-sortable":true,
            "readOnly":true,
            "title":"Last Updated Date"
        },
        "prompt":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/oraCxSalesCommonKeyterms.KeytermPrompt_item"
                },
                {
                    "$ref":"#/components/schemas/__busObj_context"
                },
                {
                    "type":"object",
                    "x-searchable":true
                }
            ]
        }
    },
    "x-primaryKey":[
        "id"
    ]
}

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 : testResult-allOf[2]

Type: object

Nested Schema : prompt

Match All

Show Source

• allOf oraCxSalesCommonKeyterms.KeytermPrompt_item
• object __busObj_context
• object prompt-allOf[2]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCxSalesCommonKeyterms.KeytermPrompt_item"
        },
        {
            "$ref":"#/components/schemas/__busObj_context"
        },
        {
            "type":"object",
            "x-searchable":true
        }
    ]
}

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.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCxSalesCommonKeyterms.KeytermPrompt_item-fields"
        },
        {
            "type":"object",
            "title":"Key Term Prompt",
            "x-hints":{
                "titlePlural":"Key Term Prompts"
            },
            "description":"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: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"big-integer",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "name":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "title":"Name"
        },
        "description":{
            "type":"string",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "title":"Description"
        },
        "text":{
            "type":"string",
            "x-searchable":true,
            "title":"Prompt"
        },
        "latestAdditionalInstructions":{
            "type":"string",
            "nullable":true
        },
        "status":{
            "allOf":[
                {
                    "type":"string",
                    "default":"ORA_OKC_DRAFT",
                    "nullable":true,
                    "x-searchable":true,
                    "x-sortable":true,
                    "x-oj":{
                        "transform":{
                            "path":"https://static-stage.oracle.com/cdn/boss/2307.0.480/js/transforms/metadata-transformer-jet-plugin.js",
                            "name":"transformEnumExtensions"
                        }
                    },
                    "title":"Status"
                },
                {
                    "$ref":"#/components/schemas/oraCxSalesCommonKeyterms.PromptStatusType_enum"
                }
            ]
        },
        "createdBy":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "title":"Created By"
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "x-sortable":true,
            "readOnly":true,
            "title":"Created On"
        },
        "updatedBy":{
            "type":"string",
            "x-searchable":true,
            "readOnly":true,
            "title":"Last Updated By"
        },
        "timeUpdated":{
            "type":"string",
            "format":"date-time",
            "x-sortable":true,
            "readOnly":true,
            "title":"Last Updated Date"
        },
        "keyterm":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/oraCxSalesCommonKeyterms.Keyterm_item"
                },
                {
                    "$ref":"#/components/schemas/__busObj_context"
                },
                {
                    "type":"object",
                    "x-searchable":true
                }
            ]
        }
    },
    "x-primaryKey":[
        "id"
    ]
}

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 : prompt-allOf[2]

Type: object

Nested Schema : keyterm

Match All

Show Source

• allOf oraCxSalesCommonKeyterms.Keyterm_item
• object __busObj_context
• object keyterm-allOf[2]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCxSalesCommonKeyterms.Keyterm_item"
        },
        {
            "$ref":"#/components/schemas/__busObj_context"
        },
        {
            "type":"object",
            "x-searchable":true
        }
    ]
}

Nested Schema : status

Match All

Show Source

• string
  Title: Status

  Default Value: ORA_OKC_DRAFT
• string
  Allowed Values: [ "ORA_OKC_DRAFT", "ORA_OKC_ACTIVE", "ORA_OKC_INACTIVE" ]

{
    "allOf":[
        {
            "type":"string",
            "default":"ORA_OKC_DRAFT",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "x-oj":{
                "transform":{
                    "path":"https://static-stage.oracle.com/cdn/boss/2307.0.480/js/transforms/metadata-transformer-jet-plugin.js",
                    "name":"transformEnumExtensions"
                }
            },
            "title":"Status"
        },
        {
            "$ref":"#/components/schemas/oraCxSalesCommonKeyterms.PromptStatusType_enum"
        }
    ]
}

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.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCxSalesCommonKeyterms.Keyterm_item-fields"
        },
        {
            "type":"object",
            "title":"Key Term",
            "x-hints":{
                "titlePlural":"Key Terms"
            },
            "description":"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: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "title":"Code"
        },
        "name":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "title":"Name"
        },
        "outputType":{
            "allOf":[
                {
                    "type":"string",
                    "x-searchable":true,
                    "x-sortable":true,
                    "x-oj":{
                        "transform":{
                            "path":"https://static-stage.oracle.com/cdn/boss/2307.0.480/js/transforms/metadata-transformer-jet-plugin.js",
                            "name":"transformEnumExtensions"
                        }
                    },
                    "title":"Output Type"
                },
                {
                    "$ref":"#/components/schemas/oraCxSalesCommonKeyterms.KeytermOutputType_enum"
                }
            ]
        },
        "activeFlag":{
            "type":"boolean",
            "default":true,
            "x-searchable":true,
            "x-sortable":true,
            "title":"Status"
        },
        "createdBy":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "title":"Created By"
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "x-sortable":true,
            "readOnly":true,
            "title":"Created On"
        },
        "updatedBy":{
            "type":"string",
            "x-searchable":true,
            "readOnly":true,
            "title":"Last Updated By"
        },
        "timeUpdated":{
            "type":"string",
            "format":"date-time",
            "x-sortable":true,
            "readOnly":true,
            "title":"Last Updated Date"
        },
        "group":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/oraCxSalesCommonKeyterms.KeytermGroupLookup_item-fields"
                },
                {
                    "$ref":"#/components/schemas/__busObj_context"
                },
                {
                    "type":"object",
                    "title":"Group",
                    "x-searchable":true
                }
            ]
        }
    },
    "x-primaryKey":[
        "code"
    ]
}

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 : keyterm-allOf[2]

Type: object

Nested Schema : group

Match All

Show Source

• allOf oraCxSalesCommonKeyterms.KeytermGroupLookup_item-fields
• object __busObj_context
• object Group
  Title: Group

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCxSalesCommonKeyterms.KeytermGroupLookup_item-fields"
        },
        {
            "$ref":"#/components/schemas/__busObj_context"
        },
        {
            "type":"object",
            "title":"Group",
            "x-searchable":true
        }
    ]
}

Nested Schema : outputType

Match All

Show Source

• string
  Title: Output Type
• string
  Allowed Values: [ "ORA_OKC_TEXT", "ORA_OKC_NUMBER", "ORA_OKC_DATE" ]

{
    "allOf":[
        {
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "x-oj":{
                "transform":{
                    "path":"https://static-stage.oracle.com/cdn/boss/2307.0.480/js/transforms/metadata-transformer-jet-plugin.js",
                    "name":"transformEnumExtensions"
                }
            },
            "title":"Output Type"
        },
        {
            "$ref":"#/components/schemas/oraCxSalesCommonKeyterms.KeytermOutputType_enum"
        }
    ]
}

Nested Schema : oraCxSalesCommonKeyterms.KeytermGroupLookup_item-fields

Match All

Show Source

• object oraCommonAppsInfraObjects.LookupCode_abstract-item
• object oraCxSalesCommonKeyterms.KeytermGroupLookup_item-fields-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_abstract-item"
        },
        {
            "type":"object",
            "properties":{
                "lookupType":{
                    "title":"Lookup Type ID",
                    "description":"The unique identifier of the Lookup Type.",
                    "type":"string"
                },
                "lookupCategoryId":{
                    "title":"Lookup Category",
                    "description":"The lookup category of the Lookup Code.",
                    "type":"string"
                },
                "lookupCode":{
                    "title":"Lookup Code ID",
                    "description":"The unique identifier of the Lookup Code.",
                    "type":"string"
                },
                "meaning":{
                    "title":"Lookup Code Meaning",
                    "description":"The translated meaning of the Lookup Code.",
                    "type":"string"
                },
                "description":{
                    "title":"Lookup Code Description",
                    "description":"The translated description of the Lookup Code.",
                    "type":"string"
                },
                "enabledFlag":{
                    "title":"Lookup Code Enabled",
                    "description":"The enabled flag of the Lookup Code.",
                    "type":"boolean"
                },
                "startDateActive":{
                    "title":"Start Date Active",
                    "description":"The active start date of the Lookup Code.",
                    "type":"string"
                },
                "endDateActive":{
                    "title":"End Date Active",
                    "description":"The active end date of the Lookup Code.",
                    "type":"string"
                },
                "displaySequence":{
                    "title":"Display Sequence",
                    "description":"The display sequence of the Lookup Code.",
                    "type":"string"
                },
                "tag":{
                    "title":"Lookup Tag",
                    "description":"The tag value of the Lookup Code.",
                    "type":"string"
                },
                "createdBy":{
                    "title":"Created By",
                    "description":"The user who created the record.",
                    "type":"string"
                },
                "timeCreated":{
                    "title":"Created On",
                    "description":"The date and time when the record was created.",
                    "type":"string"
                },
                "updatedBy":{
                    "title":"Last Updated By",
                    "description":"The user who last updated the record.",
                    "type":"string"
                },
                "timeUpdated":{
                    "title":"Last Updated Date",
                    "description":"The date and time when the record was last updated.",
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : oraCommonAppsInfraObjects.LookupCode_abstract-item

Type: object

Show Source

• $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

{
    "type":"object",
    "properties":{
        "lookupType":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "lookupCategoryId":{
            "type":"string",
            "format":"big-integer",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "lookupCode":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "meaning":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "description":{
            "type":"string",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "enabledFlag":{
            "type":"boolean",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "startDateActive":{
            "type":"string",
            "format":"date",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "endDateActive":{
            "type":"string",
            "format":"date",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "displaySequence":{
            "type":"string",
            "format":"big-integer",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "tag":{
            "type":"string",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "createdBy":{
            "type":"string",
            "readOnly":true
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "readOnly":true
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true
        },
        "timeUpdated":{
            "type":"string",
            "format":"date-time",
            "readOnly":true
        },
        "$sourceLang":{
            "type":"string",
            "readOnly":true
        }
    },
    "x-primaryKey":[
        "lookupType",
        "lookupCode"
    ]
}

Nested Schema : oraCxSalesCommonKeyterms.KeytermGroupLookup_item-fields-allOf[1]

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "lookupType":{
            "title":"Lookup Type ID",
            "description":"The unique identifier of the Lookup Type.",
            "type":"string"
        },
        "lookupCategoryId":{
            "title":"Lookup Category",
            "description":"The lookup category of the Lookup Code.",
            "type":"string"
        },
        "lookupCode":{
            "title":"Lookup Code ID",
            "description":"The unique identifier of the Lookup Code.",
            "type":"string"
        },
        "meaning":{
            "title":"Lookup Code Meaning",
            "description":"The translated meaning of the Lookup Code.",
            "type":"string"
        },
        "description":{
            "title":"Lookup Code Description",
            "description":"The translated description of the Lookup Code.",
            "type":"string"
        },
        "enabledFlag":{
            "title":"Lookup Code Enabled",
            "description":"The enabled flag of the Lookup Code.",
            "type":"boolean"
        },
        "startDateActive":{
            "title":"Start Date Active",
            "description":"The active start date of the Lookup Code.",
            "type":"string"
        },
        "endDateActive":{
            "title":"End Date Active",
            "description":"The active end date of the Lookup Code.",
            "type":"string"
        },
        "displaySequence":{
            "title":"Display Sequence",
            "description":"The display sequence of the Lookup Code.",
            "type":"string"
        },
        "tag":{
            "title":"Lookup Tag",
            "description":"The tag value of the Lookup Code.",
            "type":"string"
        },
        "createdBy":{
            "title":"Created By",
            "description":"The user who created the record.",
            "type":"string"
        },
        "timeCreated":{
            "title":"Created On",
            "description":"The date and time when the record was created.",
            "type":"string"
        },
        "updatedBy":{
            "title":"Last Updated By",
            "description":"The user who last updated the record.",
            "type":"string"
        },
        "timeUpdated":{
            "title":"Last Updated Date",
            "description":"The date and time when the record was last updated.",
            "type":"string"
        }
    }
}

Nested Schema : Group

Type: object

Title: Group

Nested Schema : $context

Type: object

Show Source

• etag: string
• links: object links
  Read Only: true

{
    "type":"object",
    "properties":{
        "etag":{
            "type":"string"
        },
        "links":{
            "type":"object",
            "properties":{
                "$self":{
                    "type":"object",
                    "properties":{
                        "href":{
                            "type":"string"
                        }
                    }
                }
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: object

Read Only: true

Show Source

• $self: object $self

{
    "type":"object",
    "properties":{
        "$self":{
            "type":"object",
            "properties":{
                "href":{
                    "type":"string"
                }
            }
        }
    },
    "readOnly":true
}

Nested Schema : $self

Type: object

Show Source

• href: string

{
    "type":"object",
    "properties":{
        "href":{
            "type":"string"
        }
    }
}

Nested Schema : testResult

Match One Schema

Show Source

• object testResult-oneOf[0]
• object __busObj_context

{
    "oneOf":[
        {
            "type":"object",
            "properties":{
                "id":{
                    "$ref":"#/components/schemas/oraCxSalesCommonKeyterms.PromptTestResult_item-fields/properties/id"
                }
            }
        },
        {
            "$ref":"#/components/schemas/__busObj_context"
        }
    ]
}

Nested Schema : testResult-oneOf[0]

Type: object

Show Source

• id: string (big-integer)
  Read Only: true

{
    "type":"object",
    "properties":{
        "id":{
            "$ref":"#/components/schemas/oraCxSalesCommonKeyterms.PromptTestResult_item-fields/properties/id"
        }
    }
}

Back to Top

Response

Default Response

no content

Back to Top

Examples

The following example shows how to create a citation for a keyterm prompt test result 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/{keyterms_id}/prompts/{keyterms-prompts_id}/testResults/{keyterms-prompts-testResults_id}/citations' \ --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.

{
    "sequenceNumber":10,
    "citation":"Placeholder Text where prompt is present"
}

Example of Response

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

201 Created

Back to Top