Jump to

• Request
• Response

Get all service request message attachments using advanced query

post

/api/boss/data/objects/ora/cxServiceCore/srMgmt/v1/serviceRequests/{serviceRequests_id}/messages/{serviceRequests-messages_id}/$attachments/$query

Request

Path Parameters

• serviceRequests-messages_id(required): string
  This path parameter maps to the following field defined in the Service Requests/Messages REST resource:
  

  1. id: The unique identifier associated with the service request message.
• serviceRequests_id(required): string
  This path parameter maps to the following field defined in the Service Requests REST resource:
  

  1. number: The unique number that's used to identify a service request. You can edit the service request number to a format that's best suitable to your organizational requirements.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Match All

Show Source

• object schema
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/__item_query"
        },
        {
            "type":"object",
            "properties":{
                "collection":{
                    "type":"object",
                    "description":"Defines query criteria that can be applied on a resource collection.",
                    "properties":{
                        "filter":{
                            "type":"string",
                            "description":"The resource collection will be queried using the specified filter condition."
                        },
                        "limit":{
                            "type":"integer",
                            "description":"Restricts the number of resource items returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resource items."
                        },
                        "offset":{
                            "type":"integer",
                            "description":"Defines the starting position of the resource collection. If offset exceeds the resource count then no resource items are returned."
                        },
                        "sortBy":{
                            "type":"array",
                            "description":"Orders a resource collection based on the specified fields.",
                            "items":{
                                "oneOf":[
                                    {
                                        "type":"string",
                                        "description":"Name of field based on which sorting will happen. Order is ascending."
                                    },
                                    {
                                        "type":"object",
                                        "description":"Object with single entry. Key must be name of field based on which sorting will happen. Value must be either asc or desc to decide the sort order."
                                    }
                                ]
                            }
                        },
                        "privilege":{
                            "type":"string",
                            "description":"Represents the privilege or action required to check for while serving a request to access a resource."
                        }
                    },
                    "additionalProperties":false
                }
            }
        }
    ]
}

Nested Schema : schema

Type: object

Show Source

• accessors: object accessors
  Maps accessor names to query objects specific to corresponding accessors. Query object for each accessor supports query capabilities similar to the base.
• fields: array fields
  Restricts the resource fields. Only the specified fields and mandatory system fields are returned.
• subTypes: object subTypes
  Maps discriminator values (as defined in subtypes) to query objects specific to corresponding subtypes. Subtype-specific query objects support a subset(fields,accessors,filter) of the query capabilities when compared to the base.

{
    "type":"object",
    "properties":{
        "fields":{
            "type":"array",
            "description":"Restricts the resource fields. Only the specified fields and mandatory system fields are returned.",
            "items":{
                "type":"string"
            }
        },
        "subTypes":{
            "type":"object",
            "description":"Maps discriminator values (as defined in subtypes) to query objects specific to corresponding subtypes. Subtype-specific query objects support a subset(fields,accessors,filter) of the query capabilities when compared to the base."
        },
        "accessors":{
            "type":"object",
            "description":"Maps accessor names to query objects specific to corresponding accessors. Query object for each accessor supports query capabilities similar to the base."
        }
    }
}

Nested Schema : type

Type: object

Show Source

• collection: object collection
  Defines query criteria that can be applied on a resource collection.

{
    "type":"object",
    "properties":{
        "collection":{
            "type":"object",
            "description":"Defines query criteria that can be applied on a resource collection.",
            "properties":{
                "filter":{
                    "type":"string",
                    "description":"The resource collection will be queried using the specified filter condition."
                },
                "limit":{
                    "type":"integer",
                    "description":"Restricts the number of resource items returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resource items."
                },
                "offset":{
                    "type":"integer",
                    "description":"Defines the starting position of the resource collection. If offset exceeds the resource count then no resource items are returned."
                },
                "sortBy":{
                    "type":"array",
                    "description":"Orders a resource collection based on the specified fields.",
                    "items":{
                        "oneOf":[
                            {
                                "type":"string",
                                "description":"Name of field based on which sorting will happen. Order is ascending."
                            },
                            {
                                "type":"object",
                                "description":"Object with single entry. Key must be name of field based on which sorting will happen. Value must be either asc or desc to decide the sort order."
                            }
                        ]
                    }
                },
                "privilege":{
                    "type":"string",
                    "description":"Represents the privilege or action required to check for while serving a request to access a resource."
                }
            },
            "additionalProperties":false
        }
    }
}

Nested Schema : accessors

Type: object

Maps accessor names to query objects specific to corresponding accessors. Query object for each accessor supports query capabilities similar to the base.

Nested Schema : fields

Type: array

Restricts the resource fields. Only the specified fields and mandatory system fields are returned.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Restricts the resource fields. Only the specified fields and mandatory system fields are returned.",
    "items":{
        "type":"string"
    }
}

Nested Schema : subTypes

Type: object

Maps discriminator values (as defined in subtypes) to query objects specific to corresponding subtypes. Subtype-specific query objects support a subset(fields,accessors,filter) of the query capabilities when compared to the base.

Nested Schema : collection

Type: object

Defines query criteria that can be applied on a resource collection.

Show Source

• filter: string
  The resource collection will be queried using the specified filter condition.
• limit: integer
  Restricts the number of resource items returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resource items.
• offset: integer
  Defines the starting position of the resource collection. If offset exceeds the resource count then no resource items are returned.
• privilege: string
  Represents the privilege or action required to check for while serving a request to access a resource.
• sortBy: array sortBy
  Orders a resource collection based on the specified fields.

{
    "type":"object",
    "description":"Defines query criteria that can be applied on a resource collection.",
    "properties":{
        "filter":{
            "type":"string",
            "description":"The resource collection will be queried using the specified filter condition."
        },
        "limit":{
            "type":"integer",
            "description":"Restricts the number of resource items returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resource items."
        },
        "offset":{
            "type":"integer",
            "description":"Defines the starting position of the resource collection. If offset exceeds the resource count then no resource items are returned."
        },
        "sortBy":{
            "type":"array",
            "description":"Orders a resource collection based on the specified fields.",
            "items":{
                "oneOf":[
                    {
                        "type":"string",
                        "description":"Name of field based on which sorting will happen. Order is ascending."
                    },
                    {
                        "type":"object",
                        "description":"Object with single entry. Key must be name of field based on which sorting will happen. Value must be either asc or desc to decide the sort order."
                    }
                ]
            }
        },
        "privilege":{
            "type":"string",
            "description":"Represents the privilege or action required to check for while serving a request to access a resource."
        }
    },
    "additionalProperties":false
}

Nested Schema : sortBy

Type: array

Orders a resource collection based on the specified fields.

Show Source

• Array of: items

{
    "type":"array",
    "description":"Orders a resource collection based on the specified fields.",
    "items":{
        "oneOf":[
            {
                "type":"string",
                "description":"Name of field based on which sorting will happen. Order is ascending."
            },
            {
                "type":"object",
                "description":"Object with single entry. Key must be name of field based on which sorting will happen. Value must be either asc or desc to decide the sort order."
            }
        ]
    }
}

Nested Schema : items

Match One Schema

Show Source

• string
  Name of field based on which sorting will happen. Order is ascending.
• object type
  Object with single entry. Key must be name of field based on which sorting will happen. Value must be either asc or desc to decide the sort order.

{
    "oneOf":[
        {
            "type":"string",
            "description":"Name of field based on which sorting will happen. Order is ascending."
        },
        {
            "type":"object",
            "description":"Object with single entry. Key must be name of field based on which sorting will happen. Value must be either asc or desc to decide the sort order."
        }
    ]
}

Nested Schema : type

Type: object

Object with single entry. Key must be name of field based on which sorting will happen. Value must be either asc or desc to decide the sort order.

Back to Top

Response

Default Response

An array of items response

Body ()

Root Schema : serviceRequests-messages-_attachments

Match All

Show Source

• object __collection_context
• object serviceRequests-messages-_attachments-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/__collection_context"
        },
        {
            "type":"object",
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/serviceRequests-messages-_attachments_item-response"
                    }
                }
            }
        }
    ]
}

Nested Schema : __collection_context

Type: object

Show Source

• hasMore: boolean

{
    "type":"object",
    "properties":{
        "hasMore":{
            "type":"boolean"
        }
    }
}

Nested Schema : serviceRequests-messages-_attachments-allOf[1]

Type: object

Show Source

• items: array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/serviceRequests-messages-_attachments_item-response"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: serviceRequests-messages-_attachments_item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/serviceRequests-messages-_attachments_item-response"
    }
}

Nested Schema : serviceRequests-messages-_attachments_item-response

Match All

Show Source

• allOf oraCxServiceCoreSrMgmt.MessageAttachment_item
• object __busObj_context

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCxServiceCoreSrMgmt.MessageAttachment_item"
        },
        {
            "$ref":"#/components/schemas/__busObj_context"
        }
    ]
}

Nested Schema : oraCxServiceCoreSrMgmt.MessageAttachment_item

Match All

Message attachment contains information about files or documents attached to messages associated with a service request.

Show Source

• allOf oraCxServiceCoreSrMgmt.MessageAttachment_item-fields
• object Service Request Message Attachment
  Title: Service Request Message Attachment

  Message attachment contains information about files or documents attached to messages associated with a service request.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCxServiceCoreSrMgmt.MessageAttachment_item-fields"
        },
        {
            "type":"object",
            "title":"Service Request Message Attachment",
            "x-hints":{
                "titlePlural":"Service Request Message Attachments",
                "qualifiedTitle":"Service Request Message Attachment",
                "qualifiedTitlePlural":"Service Request Message Attachments"
            },
            "description":"Message attachment contains information about files or documents attached to messages associated with a service request."
        }
    ]
}

Nested Schema : oraCxServiceCoreSrMgmt.MessageAttachment_item-fields

Match All

Show Source

• object oraCxServiceCoreSrMgmt.MessageAttachment_item-fields-allOf[0]
• object oraCommonAppsInfraAttachments.Attachment_abstract-item
• object oraCxServiceCoreSrMgmt.MessageAttachment_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":"The category of the attachment."
                        },
                        {
                            "$ref":"#/components/schemas/oraCxServiceCoreSrMgmt.MessageAttachmentCategory_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 : oraCxServiceCoreSrMgmt.MessageAttachment_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":"The category of the attachment."
                },
                {
                    "$ref":"#/components/schemas/oraCxServiceCoreSrMgmt.MessageAttachmentCategory_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 : oraCxServiceCoreSrMgmt.MessageAttachment_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 : Service Request Message Attachment

Type: object

Title: Service Request Message Attachment

Message attachment contains information about files or documents attached to messages associated with a service request.

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

The category of the attachment.

Show Source

• string
  Title: Category

  Default Value: MISC

  The category of the attachment.
• string
  Allowed Values: [ "SVC_INLINE", "SVC_INTERNAL", "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":"The category of the attachment."
        },
        {
            "$ref":"#/components/schemas/oraCxServiceCoreSrMgmt.MessageAttachmentCategory_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
        }
    ]
}

Back to Top