Jump to

• Request
• Response
• Examples

Update a keyterm

patch

/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:
  

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

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Match All

Show Source

• object allOf oraCxSalesCommonKeyterms.Keyterm_patch-item
• object __busObj_context
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCxSalesCommonKeyterms.Keyterm_patch-item"
        },
        {
            "$ref":"#/components/schemas/__busObj_context"
        },
        {
            "type":"object",
            "properties":{
                "prompts":{
                    "type":"object",
                    "properties":{
                        "items":{
                            "type":"array",
                            "items":{
                                "$ref":"#/components/schemas/keyterms-prompts_patch-item-request"
                            }
                        }
                    }
                }
            }
        }
    ]
}

Nested Schema : oraCxSalesCommonKeyterms.Keyterm_patch-item

Type: object

Show Source

• code:
• name:

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCxSalesCommonKeyterms.Keyterm_item"
        },
        {
            "type":"object",
            "properties":{
                "group":{
                    "oneOf":[
                        {
                            "type":"object",
                            "properties":{
                                "lookupType":{
                                    "allOf":[
                                        {
                                            "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_abstract-item/properties/lookupType"
                                        },
                                        {
                                            "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_item-fields/allOf/1/properties/lookupType"
                                        }
                                    ]
                                },
                                "lookupCode":{
                                    "allOf":[
                                        {
                                            "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_abstract-item/properties/lookupCode"
                                        },
                                        {
                                            "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_item-fields/allOf/1/properties/lookupCode"
                                        }
                                    ]
                                }
                            }
                        },
                        {
                            "$ref":"#/components/schemas/__busObj_context"
                        },
                        {
                            "type":"object",
                            "nullable":true,
                            "additionalProperties":false
                        }
                    ]
                }
            }
        }
    ],
    "properties":{
        "code":{
            "not":{
            }
        },
        "name":{
            "not":{
            }
        }
    }
}

Match All

Show Source

• allOf oraCxSalesCommonKeyterms.Keyterm_item
• object oraCxSalesCommonKeyterms.Keyterm_patch-item-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCxSalesCommonKeyterms.Keyterm_item"
        },
        {
            "type":"object",
            "properties":{
                "group":{
                    "oneOf":[
                        {
                            "type":"object",
                            "properties":{
                                "lookupType":{
                                    "allOf":[
                                        {
                                            "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_abstract-item/properties/lookupType"
                                        },
                                        {
                                            "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_item-fields/allOf/1/properties/lookupType"
                                        }
                                    ]
                                },
                                "lookupCode":{
                                    "allOf":[
                                        {
                                            "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_abstract-item/properties/lookupCode"
                                        },
                                        {
                                            "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_item-fields/allOf/1/properties/lookupCode"
                                        }
                                    ]
                                }
                            }
                        },
                        {
                            "$ref":"#/components/schemas/__busObj_context"
                        },
                        {
                            "type":"object",
                            "nullable":true,
                            "additionalProperties":false
                        }
                    ]
                }
            }
        }
    ],
    "properties":{
        "code":{
            "not":{
            }
        },
        "name":{
            "not":{
            }
        }
    }
}

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

Type: object

Show Source

• group: group

{
    "type":"object",
    "properties":{
        "group":{
            "oneOf":[
                {
                    "type":"object",
                    "properties":{
                        "lookupType":{
                            "allOf":[
                                {
                                    "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_abstract-item/properties/lookupType"
                                },
                                {
                                    "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_item-fields/allOf/1/properties/lookupType"
                                }
                            ]
                        },
                        "lookupCode":{
                            "allOf":[
                                {
                                    "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_abstract-item/properties/lookupCode"
                                },
                                {
                                    "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_item-fields/allOf/1/properties/lookupCode"
                                }
                            ]
                        }
                    }
                },
                {
                    "$ref":"#/components/schemas/__busObj_context"
                },
                {
                    "type":"object",
                    "nullable":true,
                    "additionalProperties":false
                }
            ]
        }
    }
}

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 : type

Type: object

Show Source

• prompts: object prompts

{
    "type":"object",
    "properties":{
        "prompts":{
            "type":"object",
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/keyterms-prompts_patch-item-request"
                    }
                }
            }
        }
    }
}

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 : group

Match One Schema

Show Source

• object group-oneOf[0]
• object __busObj_context
• object group-oneOf[2]

{
    "oneOf":[
        {
            "type":"object",
            "properties":{
                "lookupType":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_abstract-item/properties/lookupType"
                        },
                        {
                            "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_item-fields/allOf/1/properties/lookupType"
                        }
                    ]
                },
                "lookupCode":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_abstract-item/properties/lookupCode"
                        },
                        {
                            "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_item-fields/allOf/1/properties/lookupCode"
                        }
                    ]
                }
            }
        },
        {
            "$ref":"#/components/schemas/__busObj_context"
        },
        {
            "type":"object",
            "nullable":true,
            "additionalProperties":false
        }
    ]
}

Nested Schema : group-oneOf[0]

Type: object

Show Source

• lookupCode: lookupCode
• lookupType: lookupType

{
    "type":"object",
    "properties":{
        "lookupType":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_abstract-item/properties/lookupType"
                },
                {
                    "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_item-fields/allOf/1/properties/lookupType"
                }
            ]
        },
        "lookupCode":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_abstract-item/properties/lookupCode"
                },
                {
                    "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_item-fields/allOf/1/properties/lookupCode"
                }
            ]
        }
    }
}

Nested Schema : group-oneOf[2]

Type: object

Nested Schema : lookupCode

Match All

Show Source

• string
  Read Only: true
• string
  Title: Lookup Code ID

  The unique identifier of the Lookup Code.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_abstract-item/properties/lookupCode"
        },
        {
            "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_item-fields/allOf/1/properties/lookupCode"
        }
    ]
}

Nested Schema : lookupType

Match All

Show Source

• string
  Read Only: true
• string
  Title: Lookup Type ID

  The unique identifier of the Lookup Type.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_abstract-item/properties/lookupType"
        },
        {
            "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_item-fields/allOf/1/properties/lookupType"
        }
    ]
}

Nested Schema : prompts

Type: object

Show Source

• items: array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/keyterms-prompts_patch-item-request"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: keyterms-prompts_patch-item-request

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/keyterms-prompts_patch-item-request"
    }
}

Nested Schema : keyterms-prompts_patch-item-request

Match All

Show Source

• object allOf oraCxSalesCommonKeyterms.KeytermPrompt_patch-item
• object __busObj_context
• object keyterms-prompts_patch-item-request-allOf[2]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCxSalesCommonKeyterms.KeytermPrompt_patch-item"
        },
        {
            "$ref":"#/components/schemas/__busObj_context"
        },
        {
            "type":"object",
            "properties":{
                "testResults":{
                    "type":"object",
                    "properties":{
                        "items":{
                            "type":"array",
                            "items":{
                                "$ref":"#/components/schemas/keyterms-prompts-testResults_patch-item-request"
                            }
                        }
                    }
                },
                "$attachments":{
                    "type":"object",
                    "properties":{
                        "items":{
                            "type":"array",
                            "items":{
                                "$ref":"#/components/schemas/keyterms-prompts-_attachments_patch-item-request"
                            }
                        }
                    }
                }
            }
        }
    ]
}

Nested Schema : oraCxSalesCommonKeyterms.KeytermPrompt_patch-item

Type: object

Show Source

• name:

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCxSalesCommonKeyterms.KeytermPrompt_item"
        },
        {
            "type":"object",
            "properties":{
                "keyterm":{
                    "oneOf":[
                        {
                            "type":"object",
                            "properties":{
                                "code":{
                                    "$ref":"#/components/schemas/oraCxSalesCommonKeyterms.Keyterm_item-fields/properties/code"
                                }
                            }
                        },
                        {
                            "$ref":"#/components/schemas/__busObj_context"
                        },
                        {
                            "type":"object",
                            "nullable":true,
                            "additionalProperties":false
                        }
                    ]
                }
            }
        }
    ],
    "properties":{
        "name":{
            "not":{
            }
        }
    }
}

Match All

Show Source

• allOf oraCxSalesCommonKeyterms.KeytermPrompt_item
• object oraCxSalesCommonKeyterms.KeytermPrompt_patch-item-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCxSalesCommonKeyterms.KeytermPrompt_item"
        },
        {
            "type":"object",
            "properties":{
                "keyterm":{
                    "oneOf":[
                        {
                            "type":"object",
                            "properties":{
                                "code":{
                                    "$ref":"#/components/schemas/oraCxSalesCommonKeyterms.Keyterm_item-fields/properties/code"
                                }
                            }
                        },
                        {
                            "$ref":"#/components/schemas/__busObj_context"
                        },
                        {
                            "type":"object",
                            "nullable":true,
                            "additionalProperties":false
                        }
                    ]
                }
            }
        }
    ],
    "properties":{
        "name":{
            "not":{
            }
        }
    }
}

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

Type: object

Show Source

• keyterm: keyterm

{
    "type":"object",
    "properties":{
        "keyterm":{
            "oneOf":[
                {
                    "type":"object",
                    "properties":{
                        "code":{
                            "$ref":"#/components/schemas/oraCxSalesCommonKeyterms.Keyterm_item-fields/properties/code"
                        }
                    }
                },
                {
                    "$ref":"#/components/schemas/__busObj_context"
                },
                {
                    "type":"object",
                    "nullable":true,
                    "additionalProperties":false
                }
            ]
        }
    }
}

Nested Schema : keyterms-prompts_patch-item-request-allOf[2]

Type: object

Show Source

• $attachments: object $attachments
• testResults: object testResults

{
    "type":"object",
    "properties":{
        "testResults":{
            "type":"object",
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/keyterms-prompts-testResults_patch-item-request"
                    }
                }
            }
        },
        "$attachments":{
            "type":"object",
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/keyterms-prompts-_attachments_patch-item-request"
                    }
                }
            }
        }
    }
}

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

Type: object

Nested Schema : keyterm

Match One Schema

Show Source

• object keyterm-oneOf[0]
• object __busObj_context
• object keyterm-oneOf[2]

{
    "oneOf":[
        {
            "type":"object",
            "properties":{
                "code":{
                    "$ref":"#/components/schemas/oraCxSalesCommonKeyterms.Keyterm_item-fields/properties/code"
                }
            }
        },
        {
            "$ref":"#/components/schemas/__busObj_context"
        },
        {
            "type":"object",
            "nullable":true,
            "additionalProperties":false
        }
    ]
}

Nested Schema : keyterm-oneOf[0]

Type: object

Show Source

• code: string
  Title: Code

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

Nested Schema : keyterm-oneOf[2]

Type: object

Nested Schema : $attachments

Type: object

Show Source

• items: array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/keyterms-prompts-_attachments_patch-item-request"
            }
        }
    }
}

Nested Schema : testResults

Type: object

Show Source

• items: array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/keyterms-prompts-testResults_patch-item-request"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: keyterms-prompts-_attachments_patch-item-request

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/keyterms-prompts-_attachments_patch-item-request"
    }
}

Nested Schema : keyterms-prompts-_attachments_patch-item-request

Match All

Show Source

• allOf oraCxSalesCommonKeyterms.KeytermFileAttachment_patch-item
• object __busObj_context

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

Nested Schema : oraCxSalesCommonKeyterms.KeytermFileAttachment_patch-item

Match All

Show Source

• allOf oraCxSalesCommonKeyterms.KeytermFileAttachment_item
• allOf oraCommonAppsInfraAttachments.Attachment_patch-item

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCxSalesCommonKeyterms.KeytermFileAttachment_item"
        },
        {
            "$ref":"#/components/schemas/oraCommonAppsInfraAttachments.Attachment_patch-item"
        }
    ]
}

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.

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

Match All

Show Source

• object oraCxSalesCommonKeyterms.KeytermFileAttachment_item-fields-allOf[0]
• object oraCommonAppsInfraAttachments.Attachment_abstract-item
• object oraCxSalesCommonKeyterms.KeytermFileAttachment_item-fields-allOf[2]

{
    "allOf":[
        {
            "type":"object",
            "properties":{
                "category":{
                    "allOf":[
                        {
                            "type":"string",
                            "default":"MISC",
                            "nullable":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":"Category",
                            "description":"Attachment Category"
                        },
                        {
                            "$ref":"#/components/schemas/oraCxSalesCommonKeyterms.KeytermAttachmentCategory_enum"
                        }
                    ]
                }
            }
        },
        {
            "$ref":"#/components/schemas/oraCommonAppsInfraAttachments.Attachment_abstract-item"
        },
        {
            "type":"object",
            "properties":{
                "id":{
                    "title":"Attachment ID",
                    "description":"The unique identifier of the attachment.",
                    "type":"string"
                },
                "timeCreated":{
                    "title":"Created On",
                    "description":"The date and time when the record was created.",
                    "type":"string"
                },
                "createdBy":{
                    "title":"Created By",
                    "description":"The user who created the record.",
                    "type":"string"
                },
                "timeUpdated":{
                    "title":"Last Updated Date",
                    "description":"The date and time when the record was last updated.",
                    "type":"string"
                },
                "updatedBy":{
                    "title":"Last Updated By",
                    "description":"The user who last updated the record.",
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : oraCommonAppsInfraAttachments.Attachment_patch-item

Match All

Show Source

• allOf oraCommonAppsInfraAttachments.Attachment_item
• object oraCommonAppsInfraAttachments.Attachment_patch-item-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCommonAppsInfraAttachments.Attachment_item"
        },
        {
            "type":"object",
            "properties":{
                "document":{
                    "oneOf":[
                        {
                            "type":"object",
                            "properties":{
                                "id":{
                                    "allOf":[
                                        {
                                            "$ref":"#/components/schemas/oraCommonAppsInfraAttachments.Document_abstract-item/properties/id"
                                        },
                                        {
                                            "$ref":"#/components/schemas/oraCommonAppsInfraAttachments.Document_item-fields/allOf/1/properties/id"
                                        }
                                    ]
                                }
                            }
                        },
                        {
                            "$ref":"#/components/schemas/__busObj_context"
                        },
                        {
                            "type":"object",
                            "nullable":true,
                            "additionalProperties":false
                        }
                    ]
                }
            }
        }
    ]
}

Nested Schema : oraCommonAppsInfraAttachments.Attachment_item

Match All

The attachments such as documents, media, or a web URL that are added to a specific record.

Show Source

• allOf oraCommonAppsInfraAttachments.Attachment_item-fields
• object Attachment
  Title: Attachment

  The attachments such as documents, media, or a web URL that are added to a specific record.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCommonAppsInfraAttachments.Attachment_item-fields"
        },
        {
            "type":"object",
            "title":"Attachment",
            "x-hints":{
                "titlePlural":"Attachments"
            },
            "description":"The attachments such as documents, media, or a web URL that are added to a specific record."
        }
    ]
}

Nested Schema : oraCommonAppsInfraAttachments.Attachment_item-fields

Match All

Show Source

• object oraCommonAppsInfraAttachments.Attachment_abstract-item
• object oraCommonAppsInfraAttachments.Attachment_item-fields-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCommonAppsInfraAttachments.Attachment_abstract-item"
        },
        {
            "type":"object",
            "properties":{
                "id":{
                    "title":"Attachment ID",
                    "description":"The unique identifier of the attachment.",
                    "type":"string"
                },
                "timeCreated":{
                    "title":"Created On",
                    "description":"The date and time when the record was created.",
                    "type":"string"
                },
                "createdBy":{
                    "title":"Created By",
                    "description":"The user who created the record.",
                    "type":"string"
                },
                "timeUpdated":{
                    "title":"Last Updated Date",
                    "description":"The date and time when the record was last updated.",
                    "type":"string"
                },
                "updatedBy":{
                    "title":"Last Updated By",
                    "description":"The user who last updated the record.",
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : oraCxSalesCommonKeyterms.KeytermFileAttachment_item-fields-allOf[0]

Type: object

Show Source

• category: category

{
    "type":"object",
    "properties":{
        "category":{
            "allOf":[
                {
                    "type":"string",
                    "default":"MISC",
                    "nullable":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":"Category",
                    "description":"Attachment Category"
                },
                {
                    "$ref":"#/components/schemas/oraCxSalesCommonKeyterms.KeytermAttachmentCategory_enum"
                }
            ]
        }
    }
}

Nested Schema : oraCommonAppsInfraAttachments.Attachment_abstract-item

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"big-integer",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "readOnly":true
        },
        "createdBy":{
            "type":"string",
            "readOnly":true
        },
        "timeUpdated":{
            "type":"string",
            "format":"date-time",
            "x-sortable":true,
            "readOnly":true
        },
        "updatedBy":{
            "type":"string",
            "x-sortable":true,
            "readOnly":true
        },
        "document":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/oraCommonAppsInfraAttachments.Document_item-fields"
                },
                {
                    "$ref":"#/components/schemas/__busObj_context"
                },
                {
                    "type":"object",
                    "title":"Document Accessor",
                    "description":"The name of the accessor used to retrieve the document.",
                    "x-searchable":true
                }
            ]
        }
    },
    "x-primaryKey":[
        "id"
    ]
}

Nested Schema : oraCxSalesCommonKeyterms.KeytermFileAttachment_item-fields-allOf[2]

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "id":{
            "title":"Attachment ID",
            "description":"The unique identifier of the attachment.",
            "type":"string"
        },
        "timeCreated":{
            "title":"Created On",
            "description":"The date and time when the record was created.",
            "type":"string"
        },
        "createdBy":{
            "title":"Created By",
            "description":"The user who created the record.",
            "type":"string"
        },
        "timeUpdated":{
            "title":"Last Updated Date",
            "description":"The date and time when the record was last updated.",
            "type":"string"
        },
        "updatedBy":{
            "title":"Last Updated By",
            "description":"The user who last updated the record.",
            "type":"string"
        }
    }
}

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 : oraCommonAppsInfraAttachments.Attachment_item-fields-allOf[1]

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "id":{
            "title":"Attachment ID",
            "description":"The unique identifier of the attachment.",
            "type":"string"
        },
        "timeCreated":{
            "title":"Created On",
            "description":"The date and time when the record was created.",
            "type":"string"
        },
        "createdBy":{
            "title":"Created By",
            "description":"The user who created the record.",
            "type":"string"
        },
        "timeUpdated":{
            "title":"Last Updated Date",
            "description":"The date and time when the record was last updated.",
            "type":"string"
        },
        "updatedBy":{
            "title":"Last Updated By",
            "description":"The user who last updated the record.",
            "type":"string"
        }
    }
}

Nested Schema : Attachment

Type: object

Title: Attachment

The attachments such as documents, media, or a web URL that are added to a specific record.

Nested Schema : oraCommonAppsInfraAttachments.Attachment_patch-item-allOf[1]

Type: object

Show Source

• document: document

{
    "type":"object",
    "properties":{
        "document":{
            "oneOf":[
                {
                    "type":"object",
                    "properties":{
                        "id":{
                            "allOf":[
                                {
                                    "$ref":"#/components/schemas/oraCommonAppsInfraAttachments.Document_abstract-item/properties/id"
                                },
                                {
                                    "$ref":"#/components/schemas/oraCommonAppsInfraAttachments.Document_item-fields/allOf/1/properties/id"
                                }
                            ]
                        }
                    }
                },
                {
                    "$ref":"#/components/schemas/__busObj_context"
                },
                {
                    "type":"object",
                    "nullable":true,
                    "additionalProperties":false
                }
            ]
        }
    }
}

Nested Schema : category

Match All

Attachment Category

Show Source

• string
  Title: Category

  Default Value: MISC

  Attachment Category
• string
  Allowed Values: [ "MISC" ]

{
    "allOf":[
        {
            "type":"string",
            "default":"MISC",
            "nullable":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":"Category",
            "description":"Attachment Category"
        },
        {
            "$ref":"#/components/schemas/oraCxSalesCommonKeyterms.KeytermAttachmentCategory_enum"
        }
    ]
}

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.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCommonAppsInfraAttachments.Document_item-fields"
        },
        {
            "$ref":"#/components/schemas/__busObj_context"
        },
        {
            "type":"object",
            "title":"Document Accessor",
            "description":"The name of the accessor used to retrieve the document.",
            "x-searchable":true
        }
    ]
}

Nested Schema : oraCommonAppsInfraAttachments.Document_item-fields

Match All

Show Source

• object oraCommonAppsInfraAttachments.Document_abstract-item
• object oraCommonAppsInfraAttachments.Document_item-fields-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCommonAppsInfraAttachments.Document_abstract-item"
        },
        {
            "type":"object",
            "properties":{
                "id":{
                    "title":"Document ID",
                    "description":"The unique identifier of the document.",
                    "type":"string"
                },
                "timeCreated":{
                    "title":"Created On",
                    "description":"The date and time when the record was created.",
                    "type":"string"
                },
                "createdBy":{
                    "title":"Created By",
                    "description":"The user who created the record.",
                    "type":"string"
                },
                "timeUpdated":{
                    "title":"Last Updated Date",
                    "description":"The date and time when the record was last updated.",
                    "type":"string"
                },
                "updatedBy":{
                    "title":"Last Updated By",
                    "description":"The user who last updated the record.",
                    "type":"string"
                },
                "type":{
                    "title":"Type",
                    "description":"The type of document.",
                    "type":"string"
                },
                "description":{
                    "title":"Description",
                    "description":"The description of the document.",
                    "type":"string"
                },
                "version":{
                    "title":"Version",
                    "description":"The version of a file type document.",
                    "type":"string"
                },
                "title":{
                    "title":"Title",
                    "description":"The title of the document.",
                    "type":"string"
                },
                "fileName":{
                    "title":"File Name",
                    "description":"The file name of a file type document.",
                    "type":"string"
                },
                "managedEndpointKey":{
                    "title":"Endpoint Key",
                    "description":"The endpoint key from topology manager.",
                    "type":"string"
                },
                "managedPath":{
                    "title":"Path",
                    "description":"The relative path of the managed URL.",
                    "type":"string"
                },
                "managedUrl":{
                    "title":"Managed URL",
                    "description":"The URL that's a combination of the managed endpoint and path.",
                    "type":"string"
                },
                "mediaType":{
                    "title":"Media Type",
                    "description":"The media type of a file type document.",
                    "type":"string"
                },
                "size":{
                    "title":"Size",
                    "description":"The size of a file type document.",
                    "type":"string"
                },
                "url":{
                    "title":"URL",
                    "description":"The URL of a web page type document.",
                    "type":"string"
                },
                "name":{
                    "title":"Name",
                    "description":"The name that identifies a file type of the stored document.",
                    "type":"string"
                },
                "securityGroup":{
                    "title":"Security Group",
                    "description":"Used to get the group where the file type documents are organized.",
                    "type":"string"
                },
                "uploadParameters":{
                    "title":"Upload Parameters",
                    "description":"Used to get the parameters required to upload a file type document.",
                    "type":"object"
                },
                "downloadParameters":{
                    "title":"Download Parameters",
                    "description":"Used to get the parameters required to download a file type document.",
                    "type":"object"
                },
                "chunkingDirectives":{
                    "title":"Document",
                    "description":"Directives for customers uploading chunked files.",
                    "type":"object"
                },
                "contentEndpoint":{
                    "title":"Server Endpoint",
                    "description":"Endpoint for the content server.",
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : oraCommonAppsInfraAttachments.Document_abstract-item

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"big-integer",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "readOnly":true
        },
        "createdBy":{
            "type":"string",
            "readOnly":true
        },
        "timeUpdated":{
            "type":"string",
            "format":"date-time",
            "x-sortable":true,
            "readOnly":true
        },
        "updatedBy":{
            "type":"string",
            "x-sortable":true,
            "readOnly":true
        },
        "type":{
            "allOf":[
                {
                    "type":"string",
                    "x-oj":{
                        "transform":{
                            "path":"https://static-stage.oracle.com/cdn/boss/2307.0.480/js/transforms/metadata-transformer-jet-plugin.js",
                            "name":"transformEnumExtensions"
                        }
                    }
                },
                {
                    "$ref":"#/components/schemas/oraCommonAppsInfraAttachments.AttachmentDataType_enum"
                }
            ]
        },
        "description":{
            "type":"string",
            "nullable":true,
            "x-sortable":true
        },
        "$sourceLang":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "version":{
            "type":"string",
            "nullable":true
        },
        "title":{
            "type":"string",
            "nullable":true,
            "x-sortable":true
        },
        "fileName":{
            "type":"string",
            "nullable":true
        },
        "managedEndpointKey":{
            "type":"string",
            "nullable":true,
            "x-sortable":true
        },
        "managedPath":{
            "type":"string",
            "nullable":true
        },
        "managedUrl":{
            "type":"string",
            "nullable":true,
            "readOnly":true
        },
        "mediaType":{
            "type":"string",
            "nullable":true
        },
        "size":{
            "type":"string",
            "format":"big-integer",
            "nullable":true,
            "x-sortable":true
        },
        "url":{
            "type":"string",
            "nullable":true
        },
        "name":{
            "type":"string",
            "nullable":true
        },
        "securityGroup":{
            "type":"string",
            "nullable":true,
            "readOnly":true
        },
        "uploadParameters":{
            "type":"object",
            "properties":{
                "XFND_EXPIRES":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/oraCommonAppsInfraAttachments.UploadParameters_compositeType/properties/XFND_EXPIRES"
                        },
                        {
                            "type":"string",
                            "readOnly":true
                        }
                    ]
                },
                "XFND_RANDOM":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/oraCommonAppsInfraAttachments.UploadParameters_compositeType/properties/XFND_RANDOM"
                        },
                        {
                            "type":"string",
                            "readOnly":true
                        }
                    ]
                },
                "XFND_CERT_FP":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/oraCommonAppsInfraAttachments.UploadParameters_compositeType/properties/XFND_CERT_FP"
                        },
                        {
                            "type":"string",
                            "readOnly":true
                        }
                    ]
                },
                "XFND_SCHEME_ID":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/oraCommonAppsInfraAttachments.UploadParameters_compositeType/properties/XFND_SCHEME_ID"
                        },
                        {
                            "type":"integer",
                            "readOnly":true
                        }
                    ]
                },
                "XFND_SIGNATURE":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/oraCommonAppsInfraAttachments.UploadParameters_compositeType/properties/XFND_SIGNATURE"
                        },
                        {
                            "type":"string",
                            "readOnly":true
                        }
                    ]
                }
            }
        },
        "downloadParameters":{
            "type":"object",
            "properties":{
                "XFND_EXPIRES":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/oraCommonAppsInfraAttachments.DownloadParameters_compositeType/properties/XFND_EXPIRES"
                        },
                        {
                            "type":"string",
                            "readOnly":true
                        }
                    ]
                },
                "XFND_RANDOM":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/oraCommonAppsInfraAttachments.DownloadParameters_compositeType/properties/XFND_RANDOM"
                        },
                        {
                            "type":"string",
                            "readOnly":true
                        }
                    ]
                },
                "XFND_CERT_FP":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/oraCommonAppsInfraAttachments.DownloadParameters_compositeType/properties/XFND_CERT_FP"
                        },
                        {
                            "type":"string",
                            "readOnly":true
                        }
                    ]
                },
                "XFND_SCHEME_ID":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/oraCommonAppsInfraAttachments.DownloadParameters_compositeType/properties/XFND_SCHEME_ID"
                        },
                        {
                            "type":"integer",
                            "readOnly":true
                        }
                    ]
                },
                "XFND_SIGNATURE":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/oraCommonAppsInfraAttachments.DownloadParameters_compositeType/properties/XFND_SIGNATURE"
                        },
                        {
                            "type":"string",
                            "readOnly":true
                        }
                    ]
                },
                "version":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/oraCommonAppsInfraAttachments.DownloadParameters_compositeType/properties/version"
                        },
                        {
                            "type":"string",
                            "readOnly":true
                        }
                    ]
                }
            }
        },
        "chunkingDirectives":{
            "type":"object",
            "properties":{
                "chunkSize":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/oraCommonAppsInfraAttachments.ChunkingDirectives_compositeType/properties/chunkSize"
                        },
                        {
                            "type":"string",
                            "title":"Document",
                            "description":"The required size of each chunked file to be uploaded to the content server."
                        }
                    ]
                },
                "chunkCount":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/oraCommonAppsInfraAttachments.ChunkingDirectives_compositeType/properties/chunkCount"
                        },
                        {
                            "type":"string",
                            "title":"Document",
                            "description":"The required number of chunked files to be uploaded to the content server."
                        }
                    ]
                },
                "prefix":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/oraCommonAppsInfraAttachments.ChunkingDirectives_compositeType/properties/prefix"
                        },
                        {
                            "type":"string",
                            "title":"Document",
                            "description":"The prefix used in the file names of the chunked files."
                        }
                    ]
                }
            }
        },
        "contentEndpoint":{
            "type":"string",
            "nullable":true,
            "readOnly":true
        },
        "latestDocument":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/oraCommonAppsInfraAttachments.Document_item-fields"
                },
                {
                    "$ref":"#/components/schemas/__busObj_context"
                },
                {
                    "type":"object",
                    "title":"Latest Document",
                    "description":"The latest version of the attached document.",
                    "x-searchable":true
                }
            ]
        }
    },
    "x-primaryKey":[
        "id"
    ]
}

Nested Schema : oraCommonAppsInfraAttachments.Document_item-fields-allOf[1]

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "id":{
            "title":"Document ID",
            "description":"The unique identifier of the document.",
            "type":"string"
        },
        "timeCreated":{
            "title":"Created On",
            "description":"The date and time when the record was created.",
            "type":"string"
        },
        "createdBy":{
            "title":"Created By",
            "description":"The user who created the record.",
            "type":"string"
        },
        "timeUpdated":{
            "title":"Last Updated Date",
            "description":"The date and time when the record was last updated.",
            "type":"string"
        },
        "updatedBy":{
            "title":"Last Updated By",
            "description":"The user who last updated the record.",
            "type":"string"
        },
        "type":{
            "title":"Type",
            "description":"The type of document.",
            "type":"string"
        },
        "description":{
            "title":"Description",
            "description":"The description of the document.",
            "type":"string"
        },
        "version":{
            "title":"Version",
            "description":"The version of a file type document.",
            "type":"string"
        },
        "title":{
            "title":"Title",
            "description":"The title of the document.",
            "type":"string"
        },
        "fileName":{
            "title":"File Name",
            "description":"The file name of a file type document.",
            "type":"string"
        },
        "managedEndpointKey":{
            "title":"Endpoint Key",
            "description":"The endpoint key from topology manager.",
            "type":"string"
        },
        "managedPath":{
            "title":"Path",
            "description":"The relative path of the managed URL.",
            "type":"string"
        },
        "managedUrl":{
            "title":"Managed URL",
            "description":"The URL that's a combination of the managed endpoint and path.",
            "type":"string"
        },
        "mediaType":{
            "title":"Media Type",
            "description":"The media type of a file type document.",
            "type":"string"
        },
        "size":{
            "title":"Size",
            "description":"The size of a file type document.",
            "type":"string"
        },
        "url":{
            "title":"URL",
            "description":"The URL of a web page type document.",
            "type":"string"
        },
        "name":{
            "title":"Name",
            "description":"The name that identifies a file type of the stored document.",
            "type":"string"
        },
        "securityGroup":{
            "title":"Security Group",
            "description":"Used to get the group where the file type documents are organized.",
            "type":"string"
        },
        "uploadParameters":{
            "title":"Upload Parameters",
            "description":"Used to get the parameters required to upload a file type document.",
            "type":"object"
        },
        "downloadParameters":{
            "title":"Download Parameters",
            "description":"Used to get the parameters required to download a file type document.",
            "type":"object"
        },
        "chunkingDirectives":{
            "title":"Document",
            "description":"Directives for customers uploading chunked files.",
            "type":"object"
        },
        "contentEndpoint":{
            "title":"Server Endpoint",
            "description":"Endpoint for the content server.",
            "type":"string"
        }
    }
}

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

• chunkCount: chunkCount
• chunkSize: chunkSize
• prefix: prefix

{
    "type":"object",
    "properties":{
        "chunkSize":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/oraCommonAppsInfraAttachments.ChunkingDirectives_compositeType/properties/chunkSize"
                },
                {
                    "type":"string",
                    "title":"Document",
                    "description":"The required size of each chunked file to be uploaded to the content server."
                }
            ]
        },
        "chunkCount":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/oraCommonAppsInfraAttachments.ChunkingDirectives_compositeType/properties/chunkCount"
                },
                {
                    "type":"string",
                    "title":"Document",
                    "description":"The required number of chunked files to be uploaded to the content server."
                }
            ]
        },
        "prefix":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/oraCommonAppsInfraAttachments.ChunkingDirectives_compositeType/properties/prefix"
                },
                {
                    "type":"string",
                    "title":"Document",
                    "description":"The prefix used in the file names of the chunked files."
                }
            ]
        }
    }
}

Nested Schema : downloadParameters

Type: object

Show Source

• version: version
• XFND_CERT_FP: XFND_CERT_FP
• XFND_EXPIRES: XFND_EXPIRES
• XFND_RANDOM: XFND_RANDOM
• XFND_SCHEME_ID: XFND_SCHEME_ID
• XFND_SIGNATURE: XFND_SIGNATURE

{
    "type":"object",
    "properties":{
        "XFND_EXPIRES":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/oraCommonAppsInfraAttachments.DownloadParameters_compositeType/properties/XFND_EXPIRES"
                },
                {
                    "type":"string",
                    "readOnly":true
                }
            ]
        },
        "XFND_RANDOM":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/oraCommonAppsInfraAttachments.DownloadParameters_compositeType/properties/XFND_RANDOM"
                },
                {
                    "type":"string",
                    "readOnly":true
                }
            ]
        },
        "XFND_CERT_FP":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/oraCommonAppsInfraAttachments.DownloadParameters_compositeType/properties/XFND_CERT_FP"
                },
                {
                    "type":"string",
                    "readOnly":true
                }
            ]
        },
        "XFND_SCHEME_ID":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/oraCommonAppsInfraAttachments.DownloadParameters_compositeType/properties/XFND_SCHEME_ID"
                },
                {
                    "type":"integer",
                    "readOnly":true
                }
            ]
        },
        "XFND_SIGNATURE":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/oraCommonAppsInfraAttachments.DownloadParameters_compositeType/properties/XFND_SIGNATURE"
                },
                {
                    "type":"string",
                    "readOnly":true
                }
            ]
        },
        "version":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/oraCommonAppsInfraAttachments.DownloadParameters_compositeType/properties/version"
                },
                {
                    "type":"string",
                    "readOnly":true
                }
            ]
        }
    }
}

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.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCommonAppsInfraAttachments.Document_item-fields"
        },
        {
            "$ref":"#/components/schemas/__busObj_context"
        },
        {
            "type":"object",
            "title":"Latest Document",
            "description":"The latest version of the attached document.",
            "x-searchable":true
        }
    ]
}

Nested Schema : type

Match All

Show Source

• string
• string
  Allowed Values: [ "FILE", "WEB_PAGE", "TMURI", "TEXT" ]

{
    "allOf":[
        {
            "type":"string",
            "x-oj":{
                "transform":{
                    "path":"https://static-stage.oracle.com/cdn/boss/2307.0.480/js/transforms/metadata-transformer-jet-plugin.js",
                    "name":"transformEnumExtensions"
                }
            }
        },
        {
            "$ref":"#/components/schemas/oraCommonAppsInfraAttachments.AttachmentDataType_enum"
        }
    ]
}

Nested Schema : uploadParameters

Type: object

Show Source

• XFND_CERT_FP: XFND_CERT_FP
• XFND_EXPIRES: XFND_EXPIRES
• XFND_RANDOM: XFND_RANDOM
• XFND_SCHEME_ID: XFND_SCHEME_ID
• XFND_SIGNATURE: XFND_SIGNATURE

{
    "type":"object",
    "properties":{
        "XFND_EXPIRES":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/oraCommonAppsInfraAttachments.UploadParameters_compositeType/properties/XFND_EXPIRES"
                },
                {
                    "type":"string",
                    "readOnly":true
                }
            ]
        },
        "XFND_RANDOM":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/oraCommonAppsInfraAttachments.UploadParameters_compositeType/properties/XFND_RANDOM"
                },
                {
                    "type":"string",
                    "readOnly":true
                }
            ]
        },
        "XFND_CERT_FP":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/oraCommonAppsInfraAttachments.UploadParameters_compositeType/properties/XFND_CERT_FP"
                },
                {
                    "type":"string",
                    "readOnly":true
                }
            ]
        },
        "XFND_SCHEME_ID":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/oraCommonAppsInfraAttachments.UploadParameters_compositeType/properties/XFND_SCHEME_ID"
                },
                {
                    "type":"integer",
                    "readOnly":true
                }
            ]
        },
        "XFND_SIGNATURE":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/oraCommonAppsInfraAttachments.UploadParameters_compositeType/properties/XFND_SIGNATURE"
                },
                {
                    "type":"string",
                    "readOnly":true
                }
            ]
        }
    }
}

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.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCommonAppsInfraAttachments.ChunkingDirectives_compositeType/properties/chunkCount"
        },
        {
            "type":"string",
            "title":"Document",
            "description":"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.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCommonAppsInfraAttachments.ChunkingDirectives_compositeType/properties/chunkSize"
        },
        {
            "type":"string",
            "title":"Document",
            "description":"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

• string
• string
  Title: Document

  The prefix used in the file names of the chunked files.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCommonAppsInfraAttachments.ChunkingDirectives_compositeType/properties/prefix"
        },
        {
            "type":"string",
            "title":"Document",
            "description":"The prefix used in the file names of the chunked files."
        }
    ]
}

Nested Schema : version

Match All

Show Source

• string
• string
  Read Only: true

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCommonAppsInfraAttachments.DownloadParameters_compositeType/properties/version"
        },
        {
            "type":"string",
            "readOnly":true
        }
    ]
}

Nested Schema : XFND_CERT_FP

Match All

Show Source

• string
• string
  Read Only: true

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCommonAppsInfraAttachments.DownloadParameters_compositeType/properties/XFND_CERT_FP"
        },
        {
            "type":"string",
            "readOnly":true
        }
    ]
}

Nested Schema : XFND_EXPIRES

Match All

Show Source

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

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCommonAppsInfraAttachments.DownloadParameters_compositeType/properties/XFND_EXPIRES"
        },
        {
            "type":"string",
            "readOnly":true
        }
    ]
}

Nested Schema : XFND_RANDOM

Match All

Show Source

• string
• string
  Read Only: true

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCommonAppsInfraAttachments.DownloadParameters_compositeType/properties/XFND_RANDOM"
        },
        {
            "type":"string",
            "readOnly":true
        }
    ]
}

Nested Schema : XFND_SCHEME_ID

Match All

Show Source

• integer(int32)
• integer
  Read Only: true

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCommonAppsInfraAttachments.DownloadParameters_compositeType/properties/XFND_SCHEME_ID"
        },
        {
            "type":"integer",
            "readOnly":true
        }
    ]
}

Nested Schema : XFND_SIGNATURE

Match All

Show Source

• string
• string
  Read Only: true

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCommonAppsInfraAttachments.DownloadParameters_compositeType/properties/XFND_SIGNATURE"
        },
        {
            "type":"string",
            "readOnly":true
        }
    ]
}

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

• string
• string
  Read Only: true

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCommonAppsInfraAttachments.UploadParameters_compositeType/properties/XFND_CERT_FP"
        },
        {
            "type":"string",
            "readOnly":true
        }
    ]
}

Nested Schema : XFND_EXPIRES

Match All

Show Source

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

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCommonAppsInfraAttachments.UploadParameters_compositeType/properties/XFND_EXPIRES"
        },
        {
            "type":"string",
            "readOnly":true
        }
    ]
}

Nested Schema : XFND_RANDOM

Match All

Show Source

• string
• string
  Read Only: true

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCommonAppsInfraAttachments.UploadParameters_compositeType/properties/XFND_RANDOM"
        },
        {
            "type":"string",
            "readOnly":true
        }
    ]
}

Nested Schema : XFND_SCHEME_ID

Match All

Show Source

• integer(int32)
• integer
  Read Only: true

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCommonAppsInfraAttachments.UploadParameters_compositeType/properties/XFND_SCHEME_ID"
        },
        {
            "type":"integer",
            "readOnly":true
        }
    ]
}

Nested Schema : XFND_SIGNATURE

Match All

Show Source

• string
• string
  Read Only: true

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCommonAppsInfraAttachments.UploadParameters_compositeType/properties/XFND_SIGNATURE"
        },
        {
            "type":"string",
            "readOnly":true
        }
    ]
}

Nested Schema : document

Match One Schema

Show Source

• object document-oneOf[0]
• object __busObj_context
• object document-oneOf[2]

{
    "oneOf":[
        {
            "type":"object",
            "properties":{
                "id":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/oraCommonAppsInfraAttachments.Document_abstract-item/properties/id"
                        },
                        {
                            "$ref":"#/components/schemas/oraCommonAppsInfraAttachments.Document_item-fields/allOf/1/properties/id"
                        }
                    ]
                }
            }
        },
        {
            "$ref":"#/components/schemas/__busObj_context"
        },
        {
            "type":"object",
            "nullable":true,
            "additionalProperties":false
        }
    ]
}

Nested Schema : document-oneOf[0]

Type: object

Show Source

• id: id

{
    "type":"object",
    "properties":{
        "id":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/oraCommonAppsInfraAttachments.Document_abstract-item/properties/id"
                },
                {
                    "$ref":"#/components/schemas/oraCommonAppsInfraAttachments.Document_item-fields/allOf/1/properties/id"
                }
            ]
        }
    }
}

Nested Schema : document-oneOf[2]

Type: object

Nested Schema : id

Match All

Show Source

• string(big-integer)
  Read Only: true
• string
  Title: Document ID

  The unique identifier of the document.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCommonAppsInfraAttachments.Document_abstract-item/properties/id"
        },
        {
            "$ref":"#/components/schemas/oraCommonAppsInfraAttachments.Document_item-fields/allOf/1/properties/id"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: keyterms-prompts-testResults_patch-item-request

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/keyterms-prompts-testResults_patch-item-request"
    }
}

Nested Schema : keyterms-prompts-testResults_patch-item-request

Match All

Show Source

• object allOf oraCxSalesCommonKeyterms.PromptTestResult_patch-item
• object __busObj_context
• object keyterms-prompts-testResults_patch-item-request-allOf[2]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCxSalesCommonKeyterms.PromptTestResult_patch-item"
        },
        {
            "$ref":"#/components/schemas/__busObj_context"
        },
        {
            "type":"object",
            "properties":{
                "keytermFile":{
                    "$ref":"#/components/schemas/keyterms-prompts-testResults-keytermFile_patch-item-request"
                },
                "citations":{
                    "type":"object",
                    "properties":{
                        "items":{
                            "type":"array",
                            "items":{
                                "$ref":"#/components/schemas/keyterms-prompts-testResults-citations_patch-item-request"
                            }
                        }
                    }
                }
            }
        }
    ]
}

Nested Schema : oraCxSalesCommonKeyterms.PromptTestResult_patch-item

Type: object

Show Source

• promptText:
• submitDate:

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCxSalesCommonKeyterms.PromptTestResult_item"
        },
        {
            "type":"object",
            "properties":{
                "prompt":{
                    "oneOf":[
                        {
                            "type":"object",
                            "properties":{
                                "id":{
                                    "$ref":"#/components/schemas/oraCxSalesCommonKeyterms.KeytermPrompt_item-fields/properties/id"
                                }
                            }
                        },
                        {
                            "$ref":"#/components/schemas/__busObj_context"
                        },
                        {
                            "type":"object",
                            "nullable":true,
                            "additionalProperties":false
                        }
                    ]
                }
            }
        }
    ],
    "properties":{
        "promptText":{
            "not":{
            }
        },
        "submitDate":{
            "not":{
            }
        }
    }
}

Match All

Show Source

• allOf oraCxSalesCommonKeyterms.PromptTestResult_item
• object oraCxSalesCommonKeyterms.PromptTestResult_patch-item-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCxSalesCommonKeyterms.PromptTestResult_item"
        },
        {
            "type":"object",
            "properties":{
                "prompt":{
                    "oneOf":[
                        {
                            "type":"object",
                            "properties":{
                                "id":{
                                    "$ref":"#/components/schemas/oraCxSalesCommonKeyterms.KeytermPrompt_item-fields/properties/id"
                                }
                            }
                        },
                        {
                            "$ref":"#/components/schemas/__busObj_context"
                        },
                        {
                            "type":"object",
                            "nullable":true,
                            "additionalProperties":false
                        }
                    ]
                }
            }
        }
    ],
    "properties":{
        "promptText":{
            "not":{
            }
        },
        "submitDate":{
            "not":{
            }
        }
    }
}

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

Type: object

Show Source

• prompt: prompt

{
    "type":"object",
    "properties":{
        "prompt":{
            "oneOf":[
                {
                    "type":"object",
                    "properties":{
                        "id":{
                            "$ref":"#/components/schemas/oraCxSalesCommonKeyterms.KeytermPrompt_item-fields/properties/id"
                        }
                    }
                },
                {
                    "$ref":"#/components/schemas/__busObj_context"
                },
                {
                    "type":"object",
                    "nullable":true,
                    "additionalProperties":false
                }
            ]
        }
    }
}

Nested Schema : keyterms-prompts-testResults_patch-item-request-allOf[2]

Type: object

Show Source

• citations: object citations
• keytermFile: keyterms-prompts-testResults-keytermFile_patch-item-request

{
    "type":"object",
    "properties":{
        "keytermFile":{
            "$ref":"#/components/schemas/keyterms-prompts-testResults-keytermFile_patch-item-request"
        },
        "citations":{
            "type":"object",
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/keyterms-prompts-testResults-citations_patch-item-request"
                    }
                }
            }
        }
    }
}

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

Type: object

Nested Schema : prompt

Match One Schema

Show Source

• object prompt-oneOf[0]
• object __busObj_context
• object prompt-oneOf[2]

{
    "oneOf":[
        {
            "type":"object",
            "properties":{
                "id":{
                    "$ref":"#/components/schemas/oraCxSalesCommonKeyterms.KeytermPrompt_item-fields/properties/id"
                }
            }
        },
        {
            "$ref":"#/components/schemas/__busObj_context"
        },
        {
            "type":"object",
            "nullable":true,
            "additionalProperties":false
        }
    ]
}

Nested Schema : prompt-oneOf[0]

Type: object

Show Source

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

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

Nested Schema : prompt-oneOf[2]

Type: object

Nested Schema : citations

Type: object

Show Source

• items: array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/keyterms-prompts-testResults-citations_patch-item-request"
            }
        }
    }
}

Nested Schema : keyterms-prompts-testResults-keytermFile_patch-item-request

Match All

Show Source

• allOf oraCxSalesCommonKeyterms.KeytermFile_patch-item
• object __busObj_context

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

Nested Schema : items

Type: array

Show Source

• Array of: keyterms-prompts-testResults-citations_patch-item-request

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/keyterms-prompts-testResults-citations_patch-item-request"
    }
}

Nested Schema : keyterms-prompts-testResults-citations_patch-item-request

Match All

Show Source

• allOf oraCxSalesCommonKeyterms.PromptTestCitation_patch-item
• object __busObj_context

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

Nested Schema : oraCxSalesCommonKeyterms.PromptTestCitation_patch-item

Match All

Show Source

• allOf oraCxSalesCommonKeyterms.PromptTestCitation_item
• object oraCxSalesCommonKeyterms.PromptTestCitation_patch-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"
                        },
                        {
                            "type":"object",
                            "nullable":true,
                            "additionalProperties":false
                        }
                    ]
                }
            }
        }
    ]
}

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_patch-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"
                },
                {
                    "type":"object",
                    "nullable":true,
                    "additionalProperties":false
                }
            ]
        }
    }
}

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

Type: object

Nested Schema : testResult

Match One Schema

Show Source

• object testResult-oneOf[0]
• object __busObj_context
• object testResult-oneOf[2]

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

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"
        }
    }
}

Nested Schema : testResult-oneOf[2]

Type: object

Nested Schema : oraCxSalesCommonKeyterms.KeytermFile_patch-item

Match All

Show Source

• allOf oraCxSalesCommonKeyterms.KeytermFile_item
• object oraCxSalesCommonKeyterms.KeytermFile_patch-item-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCxSalesCommonKeyterms.KeytermFile_item"
        },
        {
            "type":"object",
            "properties":{
                "attachment":{
                    "oneOf":[
                        {
                            "type":"object",
                            "properties":{
                                "id":{
                                    "allOf":[
                                        {
                                            "$ref":"#/components/schemas/oraCommonAppsInfraAttachments.Attachment_abstract-item/properties/id"
                                        },
                                        {
                                            "$ref":"#/components/schemas/oraCommonAppsInfraAttachments.Attachment_item-fields/allOf/1/properties/id"
                                        }
                                    ]
                                }
                            }
                        },
                        {
                            "$ref":"#/components/schemas/__busObj_context"
                        },
                        {
                            "type":"object",
                            "nullable":true,
                            "additionalProperties":false
                        }
                    ]
                }
            }
        }
    ]
}

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.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCxSalesCommonKeyterms.KeytermFile_item-fields"
        },
        {
            "type":"object",
            "title":"Key Term File",
            "x-hints":{
                "titlePlural":"Key Term Files"
            },
            "description":"Key term file is the contract document that's used in prompt testing."
        }
    ]
}

Nested Schema : oraCxSalesCommonKeyterms.KeytermFile_item-fields

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"big-integer",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "parentType":{
            "allOf":[
                {
                    "type":"string",
                    "default":"OKC_PROMPT_TEST_RESULT",
                    "x-oj":{
                        "transform":{
                            "path":"https://static-stage.oracle.com/cdn/boss/2307.0.480/js/transforms/metadata-transformer-jet-plugin.js",
                            "name":"transformEnumExtensions"
                        }
                    }
                },
                {
                    "$ref":"#/components/schemas/oraCxSalesCommonKeyterms.KeytermFileParentType_enum"
                }
            ]
        },
        "documentIdentifier":{
            "type":"string",
            "nullable":true
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "title":"Created By"
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "x-sortable":true,
            "readOnly":true,
            "title":"Created On"
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "title":"Last Updated By"
        },
        "timeUpdated":{
            "type":"string",
            "format":"date-time",
            "x-sortable":true,
            "readOnly":true,
            "title":"Last Updated Date"
        },
        "attachment":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/oraCxSalesCommonKeyterms.KeytermFileAttachment_item"
                },
                {
                    "$ref":"#/components/schemas/__busObj_context"
                },
                {
                    "type":"object",
                    "x-searchable":true
                }
            ]
        }
    },
    "x-primaryKey":[
        "id"
    ]
}

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

Type: object

Show Source

• attachment: attachment

{
    "type":"object",
    "properties":{
        "attachment":{
            "oneOf":[
                {
                    "type":"object",
                    "properties":{
                        "id":{
                            "allOf":[
                                {
                                    "$ref":"#/components/schemas/oraCommonAppsInfraAttachments.Attachment_abstract-item/properties/id"
                                },
                                {
                                    "$ref":"#/components/schemas/oraCommonAppsInfraAttachments.Attachment_item-fields/allOf/1/properties/id"
                                }
                            ]
                        }
                    }
                },
                {
                    "$ref":"#/components/schemas/__busObj_context"
                },
                {
                    "type":"object",
                    "nullable":true,
                    "additionalProperties":false
                }
            ]
        }
    }
}

Nested Schema : attachment

Match All

Show Source

• allOf oraCxSalesCommonKeyterms.KeytermFileAttachment_item
• object __busObj_context
• object attachment-allOf[2]

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

Nested Schema : parentType

Match All

Show Source

• string
  Default Value: OKC_PROMPT_TEST_RESULT
• string
  Allowed Values: [ "OKC_PROMPT_TEST_RESULT", "OKC_K_KEY_TERMS" ]

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

Nested Schema : attachment-allOf[2]

Type: object

Nested Schema : attachment

Match One Schema

Show Source

• object attachment-oneOf[0]
• object __busObj_context
• object attachment-oneOf[2]

{
    "oneOf":[
        {
            "type":"object",
            "properties":{
                "id":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/oraCommonAppsInfraAttachments.Attachment_abstract-item/properties/id"
                        },
                        {
                            "$ref":"#/components/schemas/oraCommonAppsInfraAttachments.Attachment_item-fields/allOf/1/properties/id"
                        }
                    ]
                }
            }
        },
        {
            "$ref":"#/components/schemas/__busObj_context"
        },
        {
            "type":"object",
            "nullable":true,
            "additionalProperties":false
        }
    ]
}

Nested Schema : attachment-oneOf[0]

Type: object

Show Source

• id: id

{
    "type":"object",
    "properties":{
        "id":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/oraCommonAppsInfraAttachments.Attachment_abstract-item/properties/id"
                },
                {
                    "$ref":"#/components/schemas/oraCommonAppsInfraAttachments.Attachment_item-fields/allOf/1/properties/id"
                }
            ]
        }
    }
}

Nested Schema : attachment-oneOf[2]

Type: object

Nested Schema : id

Match All

Show Source

• string(big-integer)
  Read Only: true
• string
  Title: Attachment ID

  The unique identifier of the attachment.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCommonAppsInfraAttachments.Attachment_abstract-item/properties/id"
        },
        {
            "$ref":"#/components/schemas/oraCommonAppsInfraAttachments.Attachment_item-fields/allOf/1/properties/id"
        }
    ]
}

Back to Top

Response

Default Response

no content

Back to Top

Examples

The following example shows how to update a keyterm by submitting a patch request on the REST resource using cURL.

cURL Command

curl -X PATCH --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>' -D request.json

Example of Request Body

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

{
    "outputType": "ORA_OKC_TEXT",
    "activeFlag": false,
    "group": {
        "lookupType": "ORA_OKC_KEY_TERM_GROUP",
        "lookupCode": "ATS_OKC_Renewal"
    },
    "$context": {
        "etag": "5"
    },
    "prompts": {
        "items": [
            {
                "$id": "300100626372644",
                "$context": {
                    "etag": "2"
                },
                "description": "Updated prompt description"
            }
        ]
    }
}

Example of Response

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

204 Updated

Back to Top