Jump to

• Request
• Response
• Examples

Create a keyterm prompt attachment

post

/api/boss/data/objects/ora/cxSalesCommon/keyterms/v1/keyterms/{keyterms_id}/prompts/{keyterms-prompts_id}/$attachments

Request

Path Parameters

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

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

  1. code

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Match All

Show Source

• allOf oraCxSalesCommonKeyterms.KeytermFileAttachment_post-item
• object __busObj_context

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

Nested Schema : oraCxSalesCommonKeyterms.KeytermFileAttachment_post-item

Match All

Show Source

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

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCxSalesCommonKeyterms.KeytermFileAttachment_item"
        },
        {
            "$ref":"#/components/schemas/oraCommonAppsInfraAttachments.Attachment_post-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_post-item

Match All

Show Source

• allOf oraCommonAppsInfraAttachments.Attachment_item
• object oraCommonAppsInfraAttachments.Attachment_post-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"
                        }
                    ]
                }
            }
        }
    ]
}

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

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

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

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

Back to Top

Response

Default Response

no content

Back to Top

Examples

The following example shows how to create a keyterm prompt attachment by submitting a post request on the REST resource using cURL.

cURL Command

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

Example of Request Body

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

{
    "category": "MISC",
    "document": {
        "id": 300100626372917
    }
}

Example of Response

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

201 Created

Back to Top