REST API for Oracle Public Sector Permitting and Licensing

Get all communication attachments

get

/fscmRestApi/resources/11.13.18.05/publicSectorLogMessageAttachments

Request

Query Parameters

expand: string

When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
fields: string

This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

Format: ?fields=Attribute1,Attribute2

Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
finder: string
Used as a predefined finder to search the collection.

Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

The following are the available finder names and corresponding finder variables:
- PrimaryKey: Finds an ad hoc communication attachment with the specified document key.
  Finder Variables:
  - AttachmentId; integer.
  - DocumentKey; integer; The unique identifier for the communication attachment.
- simpleSearchFinder: Finds a communication attachment with the specified key word.
  Finder Variables:
  - value; string; The key word used to find a communication attachment such as type.
limit: integer

This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
links: string

This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

Example:
self,canonical
offset: integer

Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
onlyData: boolean

The resource item payload will be filtered in order to contain only data (no links section, for example).
orderBy: string

This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

Format: ?q=expression1;expression2

You can use these queryable attributes to filter this collection resource using the q query parameter:
- AgencyId; integer; The unique identifier of the agency associated with the communication attachment.
- ApplAttachIdXref; integer; The application attachment identifier associated with the communication.
- ApplAttachTypeXref; string; The application attachment type associated with the communication.
- AttachmentEntityName; string; The attachment entity name of the attachment associated with the communication.
- AttachmentId; integer; The unique identifier of the attachment associated with the communication.
- AttachmentType; string; The attribute identifying the product attachment type associated with the row.
- ConfidentialFlag; boolean; Indicates whether the attachment is a confidential document. The default value is N for no.
- CreatedByName; string; The user who created the communication attachment.
- CreationDate; string; The date and time that the communication attachment was created.
- Description; string; The description of the attachment associated with the communication.
- DocCategory; string; The document category of the attachment associated with the communication.
- DocSubcategory; string; The document sub category of the attachment associated with the communication.
- DocumentKey; integer; The unique identifier of the communication attachments. This key is generated automatically by the application.
- FileContentUploadedFlag; boolean; Indicates whether the attachment file contents has been successfully uploaded. The default value is N for no. The core attachments API has been restructured for attachments insert functionality. See Document 3034288.1 in My Oracle Support.
- FileName; string; The file name of the attachment associated with the communication.
- FileSize; integer; The file size of the attachment associated with the communication.
- FileType; string; The file type of the attachment associated with the communication.
- LastUpdateDate; string; The date that the communication attachment was last updated.
- LogMessageId; integer; The log message identifier of the attachment associated with the communication.
- LogMsgAttAgencyId; integer; The unique identifier of the agency associated with the attachment.
- LogMsgAttAttachmentId; integer; The log message attachment identifier associated with the communication.
- LogMsgAttachmentType; string; The attachment details attached to the communication.
- LogmsgAttachIdXref; integer; The original log message attachment identifier of the attachment associated with the communication.
- LogmsgAttachTypeXref; string; The original log message attachment type of the attachment associated with the communication.
- MsgDeleteFlg; string; The message delete flag of the attachment associated with the communication.
- PreviewHeight; number; The preview height of the attachment associated with the communication.
- PreviewWidth; number; The preview width of the attachment associated with the communication.
- RecordFirstKeyName; string; The record first key name of the attachment associated with the communication.
- RecordFirstKeyValue; string; The record first key value of the attachment associated with the communication.
- RecordSecondKeyName; string; The record second key name of the attachment associated with the communication.
- RecordSecondKeyValue; string; The record second key value of the attachment associated with the communication.
- RequiredFlag; boolean; Indicates whether the attachment is a required document. The default value is N for no.
- UpdatedByName; string; The user who last updated the communication attachment.
- Version; integer; The version of the attachment associated with the communication.
totalResults: boolean

The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

Metadata-Context:

If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version:

The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Response

Supported Media Types

application/json

Default Response

The following table describes the default response for this task.

Headers

Metadata-Context:

If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version:

The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Root Schema : publicSectorLogMessageAttachments

Type: object

Show Source

count(required): integer

The number of resource instances returned in the current range.
hasMore(required): boolean

Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
items: array Items

Title: Items

The items in the collection.
limit(required): integer

The actual paging size used by the server.
links(required): array Links

Title: Links

The link relations associated with the resource instance.
offset(required): integer

The offset value used in the current page.
totalResults: integer

The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/publicSectorLogMessageAttachments-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"SharedServices",
        "usage":"BusinessObject",
        "group":"psc"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

Array of: object publicSectorLogMessageAttachments-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/publicSectorLogMessageAttachments-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : publicSectorLogMessageAttachments-item-response

Type: object

Show Source

AgencyId: integer (int32)

Title: Agency ID

Default Value: 1

The unique identifier of the agency associated with the communication attachment.
ApplAttachIdXref: integer (int64)

The application attachment identifier associated with the communication.
ApplAttachTypeXref: string

Maximum Length: 15

The application attachment type associated with the communication.
AttachmentEntityName: string

Maximum Length: 255

Default Value: PSC_DOC_LOGMSG

The attachment entity name of the attachment associated with the communication.
AttachmentId: integer (int64)

The unique identifier of the attachment associated with the communication.
AttachmentType: string

Maximum Length: 15

Default Value: LOGMSG

The attribute identifying the product attachment type associated with the row.
CommLogMsgAttAccessor: array Communication Attachment Accessor

Title: Communication Attachment Accessor

The communication attachment accessors resource is used for displaying communication attachment file related information such as the file name and its URL.
ConfidentialFlag: boolean

Maximum Length: 1

Default Value: false

Indicates whether the attachment is a confidential document. The default value is N for no.
CreatedByName: string

Title: Uploaded By

The user who created the communication attachment.
CreationDate: string (date-time)

Title: Uploaded On

Read Only: true

The date and time that the communication attachment was created.
Description: string

Title: Description

Maximum Length: 100

The description of the attachment associated with the communication.
DocCategory: string

Maximum Length: 30

The document category of the attachment associated with the communication.
DocSubcategory: string

Maximum Length: 30

The document sub category of the attachment associated with the communication.
DocumentKey: integer (int64)

The unique identifier of the communication attachments. This key is generated automatically by the application.
FileContentUploadedFlag: boolean

Maximum Length: 1

Default Value: false

Indicates whether the attachment file contents has been successfully uploaded. The default value is N for no. The core attachments API has been restructured for attachments insert functionality. See Document 3034288.1 in My Oracle Support.
FileName: string

Title: File Name

Maximum Length: 255

The file name of the attachment associated with the communication.
FileSize: integer (int64)

Title: File Size

The file size of the attachment associated with the communication.
FileType: string

Maximum Length: 100

The file type of the attachment associated with the communication.
LastUpdateDate: string (date-time)

Title: Last Updated Date

Read Only: true

The date that the communication attachment was last updated.
links: array Links

Title: Links

The link relations associated with the resource instance.
LogMessageId: integer (int64)

The log message identifier of the attachment associated with the communication.
LogmsgAttachIdXref: integer (int64)

The original log message attachment identifier of the attachment associated with the communication.
LogMsgAttachmentType: string

Maximum Length: 15

The attachment details attached to the communication.
LogmsgAttachTypeXref: string

Maximum Length: 15

The original log message attachment type of the attachment associated with the communication.
LogMsgAttAgencyId: integer (int32)

The unique identifier of the agency associated with the attachment.
LogMsgAttAttachmentId: integer (int64)

The log message attachment identifier associated with the communication.
MsgDeleteFlg: string

Maximum Length: 1

The message delete flag of the attachment associated with the communication.
Preview: string (byte)

The preview of the attachment associated with the communication.
PreviewHeight: number

The preview height of the attachment associated with the communication.
PreviewWidth: number

The preview width of the attachment associated with the communication.
RecordFirstKeyName: string

Maximum Length: 32

The record first key name of the attachment associated with the communication.
RecordFirstKeyValue: string

Maximum Length: 32

The record first key value of the attachment associated with the communication.
RecordSecondKeyName: string

Maximum Length: 32

The record second key name of the attachment associated with the communication.
RecordSecondKeyValue: string

Maximum Length: 32

The record second key value of the attachment associated with the communication.
RequiredFlag: boolean

Maximum Length: 1

Default Value: false

Indicates whether the attachment is a required document. The default value is N for no.
UpdatedByName: string

Title: Last Updated By

The user who last updated the communication attachment.
Version: integer (int32)

The version of the attachment associated with the communication.

{
    "type":"object",
    "properties":{
        "CreatedByName":{
            "title":"Uploaded By",
            "type":"string",
            "description":"The user who created the communication attachment.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Uploaded On",
            "type":"string",
            "description":"The date and time that the communication attachment was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ConfidentialFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the attachment is a confidential document. The default value is N for no.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "LogmsgAttachTypeXref":{
            "maxLength":"15",
            "type":"string",
            "description":"The original log message attachment type of the attachment associated with the communication.",
            "nullable":true,
            "x-queryable":true
        },
        "PreviewHeight":{
            "type":"number",
            "description":"The preview height of the attachment associated with the communication.",
            "nullable":true,
            "x-hints":{
                "precision":"8",
                "scale":"2"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"100",
            "type":"string",
            "description":"The description of the attachment associated with the communication.",
            "nullable":true,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier of the agency associated with the communication attachment.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "LogMsgAttAttachmentId":{
            "type":"integer",
            "description":"The log message attachment identifier associated with the communication.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"255",
            "type":"string",
            "description":"The file name of the attachment associated with the communication.",
            "nullable":false,
            "x-queryable":true
        },
        "ApplAttachIdXref":{
            "type":"integer",
            "description":"The application attachment identifier associated with the communication.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RecordSecondKeyValue":{
            "maxLength":"32",
            "type":"string",
            "description":"The record second key value of the attachment associated with the communication.",
            "nullable":true,
            "x-queryable":true
        },
        "LogmsgAttachIdXref":{
            "type":"integer",
            "description":"The original log message attachment identifier of the attachment associated with the communication.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "MsgDeleteFlg":{
            "maxLength":"1",
            "type":"string",
            "description":"The message delete flag of the attachment associated with the communication.",
            "nullable":true,
            "x-queryable":true
        },
        "RecordFirstKeyValue":{
            "maxLength":"32",
            "type":"string",
            "description":"The record first key value of the attachment associated with the communication.",
            "nullable":true,
            "x-queryable":true
        },
        "Version":{
            "type":"integer",
            "description":"The version of the attachment associated with the communication.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"4"
            },
            "x-queryable":true
        },
        "ApplAttachTypeXref":{
            "maxLength":"15",
            "type":"string",
            "description":"The application attachment type associated with the communication.",
            "nullable":true,
            "x-queryable":true
        },
        "LogMsgAttachmentType":{
            "maxLength":"15",
            "type":"string",
            "description":"The attachment details attached to the communication.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DocCategory":{
            "maxLength":"30",
            "type":"string",
            "description":"The document category of the attachment associated with the communication.",
            "nullable":true,
            "x-queryable":true
        },
        "DocSubcategory":{
            "maxLength":"30",
            "type":"string",
            "description":"The document sub category of the attachment associated with the communication.",
            "nullable":true,
            "x-queryable":true
        },
        "PreviewWidth":{
            "type":"number",
            "description":"The preview width of the attachment associated with the communication.",
            "nullable":true,
            "x-hints":{
                "precision":"8",
                "scale":"2"
            },
            "x-queryable":true
        },
        "AttachmentType":{
            "maxLength":"15",
            "type":"string",
            "description":"The attribute identifying the product attachment type associated with the row.",
            "nullable":true,
            "default":"LOGMSG",
            "x-queryable":true
        },
        "UpdatedByName":{
            "title":"Last Updated By",
            "type":"string",
            "description":"The user who last updated the communication attachment.",
            "nullable":true,
            "x-queryable":true
        },
        "Preview":{
            "type":"string",
            "description":"The preview of the attachment associated with the communication.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "FileContentUploadedFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the attachment file contents has been successfully uploaded. The default value is N for no. The core attachments API has been restructured for attachments insert functionality. See Document 3034288.1 in My Oracle Support.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "AttachmentId":{
            "type":"integer",
            "description":"The unique identifier of the attachment associated with the communication.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "LogMessageId":{
            "type":"integer",
            "description":"The log message identifier of the attachment associated with the communication.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "FileType":{
            "maxLength":"100",
            "type":"string",
            "description":"The file type of the attachment associated with the communication.",
            "nullable":true,
            "x-queryable":true
        },
        "DocumentKey":{
            "type":"integer",
            "description":"The unique identifier of the communication attachments. This key is generated automatically by the application.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "RecordFirstKeyName":{
            "maxLength":"32",
            "type":"string",
            "description":"The record first key name of the attachment associated with the communication.",
            "nullable":true,
            "x-queryable":true
        },
        "RecordSecondKeyName":{
            "maxLength":"32",
            "type":"string",
            "description":"The record second key name of the attachment associated with the communication.",
            "nullable":true,
            "x-queryable":true
        },
        "RequiredFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the attachment is a required document. The default value is N for no.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "LogMsgAttAgencyId":{
            "type":"integer",
            "description":"The unique identifier of the agency associated with the attachment.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "CommLogMsgAttAccessor":{
            "title":"Communication Attachment Accessor",
            "type":"array",
            "description":"The communication attachment accessors resource is used for displaying communication attachment file related information such as the file name and its URL.",
            "items":{
                "$ref":"#/components/schemas/publicSectorLogMessageAttachments-CommLogMsgAttAccessor-item-response"
            }
        },
        "AttachmentEntityName":{
            "maxLength":"255",
            "type":"string",
            "description":"The attachment entity name of the attachment associated with the communication.",
            "nullable":true,
            "default":"PSC_DOC_LOGMSG",
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date that the communication attachment was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FileSize":{
            "title":"File Size",
            "type":"integer",
            "description":"The file size of the attachment associated with the communication.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Communication Attachment Accessor

Type: array

Title: Communication Attachment Accessor

The communication attachment accessors resource is used for displaying communication attachment file related information such as the file name and its URL.

Show Source

Array of: object publicSectorLogMessageAttachments-CommLogMsgAttAccessor-item-response

{
    "title":"Communication Attachment Accessor",
    "type":"array",
    "description":"The communication attachment accessors resource is used for displaying communication attachment file related information such as the file name and its URL.",
    "items":{
        "$ref":"#/components/schemas/publicSectorLogMessageAttachments-CommLogMsgAttAccessor-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : publicSectorLogMessageAttachments-CommLogMsgAttAccessor-item-response

Type: object

Show Source

AsyncTrackerId: string

Title: Asynchronous Upload Tracker Id

The attribute provided for exclusive use by the Attachment UI components to assist in uploading files.
AttachedDocumentId: integer (int64)

Title: Attached Document Id

The unique identifier for an attachment.
AttachmentsRevision: array Attachment Rivisions

Title: Attachment Rivisions

The attachment revision resource is used to view attachment revisions.
CategoryName: string

Title: Category

Maximum Length: 30

The unique name given to the communication attachment file-related information, which makes the attachment functionality work in conjunction with the entity name.
ContentRepositoryFileShared: boolean

Title: Shared

Indicates whether the attached file repository is shared. The default value is false.
CreatedBy: string

Title: Created By

Read Only: true

Maximum Length: 255

The user who created the attachment.
CreatedByUserName: string

Title: Created By User Name

Read Only: true

The user who created the attachment.
CreationDate: string (date-time)

Title: Creation Date

Read Only: true

The date and time when the attachment was created.
DatatypeCode: string

Title: Type

Maximum Length: 30

Default Value: FILE

The data type code of the attachment.
Description: string

Title: Description

Maximum Length: 255

The description of the attachment.
DmDocumentId: string

Maximum Length: 255

The document ID from which the attachment is created.
DmFolderPath: string

Title: Dm Folder Path

Maximum Length: 1000

The folder path of the attachment file.
DmVersionNumber: string

Maximum Length: 255

The document version number from which the attachment is created.
DownloadInfo: string

Title: DownloadInfo

The JSON object represented as a string containing information used to programmatically retrieve a file attachment.
ErrorStatusCode: string

Title: Error Status Code

The code that indicates the error status of the attachment.
ErrorStatusMessage: string

Title: Error Status Message

The message that describes the error status of the attachment.
ExpirationDate: string (date-time)

Title: Expiration Date

The date of expiration of the attachment.
FileContents: string (byte)

Title: File Contents

The core attachments API has been restructured and this attribute is no longer supported for attachments insert functionality. Use these attributes instead: UploadedFileContentType, UploadedFileLength, and UploadedFileName. See Document 3034288.1 in My Oracle Support.
FileName: string

Title: File Name

Maximum Length: 2048

The name of the attached file.
FileUrl: string

Title: File Url

The URL or web address of the attached file.
FileWebImage: string (byte)

Title: File Web Image

Read Only: true

The base64 encoded image of the file displayed in PNG format if the source is a convertible image.
LastUpdateDate: string (date-time)

Title: Last Update Date

Read Only: true

The date and time when the attachment was last updated.
LastUpdatedBy: string

Title: Last Updated By

Read Only: true

Maximum Length: 255

The user who last updated the attachment.
LastUpdatedByUserName: string

Title: Last Updated By User

Read Only: true

The user who last updated the attachment.
links: array Links

Title: Links

The link relations associated with the resource instance.
PostProcessingAction: string

Title: PostProcessingAction

The name of the action that can be performed after an attachment is uploaded.
Title: string

Title: Title

The title of the attachment.
UploadedFileContentType: string

Title: Uploaded File Content Type

The content type of the attachment, such as text/plain or csv. The core attachments API has been restructured and this attribute is now required for attachments insert functionality. See Document 3034288.1 in My Oracle Support.
UploadedFileLength: integer

Title: File Size

The file length of the attachment in bytes. The core attachments API has been restructured and this attribute is now required for attachments insert functionality. See Document 3034288.1 in My Oracle Support.
UploadedFileName: string

Title: Uploaded File Name

The name of the attached file. The core attachments API has been restructured and this attribute is now required for attachments insert functionality. See Document 3034288.1 in My Oracle Support.
UploadedText: string

Title: Uploaded Text

The text that is entered along with the attachment.
Uri: string

Title: Uri

Maximum Length: 4000

The type of universal resource identifier (URI) associated with the attachment. For example, URL.
Url: string

Title: Url

Maximum Length: 4000

The URL associated with an attachment.
UserName: string

Title: User Name

Read Only: true

Maximum Length: 255

The user's unique user name for logging into the system.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the attachment was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"255",
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"2048",
            "type":"string",
            "description":"The name of the attached file.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The base64 encoded image of the file displayed in PNG format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "AttachmentsRevision":{
            "title":"Attachment Rivisions",
            "type":"array",
            "description":"The attachment revision resource is used to view attachment revisions.",
            "items":{
                "$ref":"#/components/schemas/publicSectorLogMessageAttachments-CommLogMsgAttAccessor-AttachmentsRevision-item-response"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":"4000",
            "type":"string",
            "description":"The type of universal resource identifier (URI) associated with the attachment. For example, URL.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":"4000",
            "type":"string",
            "description":"The URL associated with an attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The unique identifier for an attachment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment, such as text/plain or csv. The core attachments API has been restructured and this attribute is now required for attachments insert functionality. See Document 3034288.1 in My Oracle Support.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"The JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"The user who created the attachment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The file length of the attachment in bytes. The core attachments API has been restructured and this attribute is now required for attachments insert functionality. See Document 3034288.1 in My Oracle Support.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who last updated the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The message that describes the error status of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UserName":{
            "title":"User Name",
            "maxLength":"255",
            "type":"string",
            "description":"The user's unique user name for logging into the system.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"The data type code of the attachment.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"The user who last updated the attachment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name of the attached file. The core attachments API has been restructured and this attribute is now required for attachments insert functionality. See Document 3034288.1 in My Oracle Support.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URL or web address of the attached file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attached file repository is shared. The default value is false.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The core attachments API has been restructured and this attribute is no longer supported for attachments insert functionality. Use these attributes instead: UploadedFileContentType, UploadedFileLength, and UploadedFileName. See Document 3034288.1 in My Oracle Support.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The date of expiration of the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The code that indicates the error status of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":"1000",
            "type":"string",
            "description":"The folder path of the attachment file.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text that is entered along with the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"The unique name given to the communication attachment file-related information, which makes the attachment functionality work in conjunction with the entity name.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date and time when the attachment was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"The attribute provided for exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

Nested Schema : Attachment Rivisions

Type: array

Title: Attachment Rivisions

The attachment revision resource is used to view attachment revisions.

Show Source

Array of: object publicSectorLogMessageAttachments-CommLogMsgAttAccessor-AttachmentsRevision-item-response

{
    "title":"Attachment Rivisions",
    "type":"array",
    "description":"The attachment revision resource is used to view attachment revisions.",
    "items":{
        "$ref":"#/components/schemas/publicSectorLogMessageAttachments-CommLogMsgAttAccessor-AttachmentsRevision-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : publicSectorLogMessageAttachments-CommLogMsgAttAccessor-AttachmentsRevision-item-response

Type: object

Show Source

AttachedDocumentId: string

Read Only: true

The unique identifier of an attached document.
ContentId: string

Maximum Length: 80

The unique identifier of the attachment content.
ErrorStatusCode: string

The code that indicates the error status of the attachment.
ErrorStatusMessage: string

The message that describes the error status of the attachment.
FileUrl: string

The web address for an attached file.
Format: string

Maximum Length: 128

The format of the attachment.
InDate: string (date-time)

The date when the file was attached.
links: array Links

Title: Links

The link relations associated with the resource instance.
RevisionId: string

Maximum Length: 80

The unique identifier of the attachment revision.
RevLabel: string

Maximum Length: 80

The label for an attachment revision.
UserRevisionId: integer

The unique identifier for an attachment revision.

{
    "type":"object",
    "properties":{
        "FileUrl":{
            "type":"string",
            "description":"The web address for an attached file.",
            "nullable":true,
            "x-queryable":false
        },
        "ErrorStatusMessage":{
            "type":"string",
            "description":"The message that describes the error status of the attachment.",
            "nullable":true,
            "x-queryable":false
        },
        "AttachedDocumentId":{
            "type":"string",
            "description":"The unique identifier of an attached document.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "InDate":{
            "type":"string",
            "description":"The date when the file was attached.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "Format":{
            "maxLength":"128",
            "type":"string",
            "description":"The format of the attachment.",
            "nullable":true,
            "x-queryable":true
        },
        "UserRevisionId":{
            "type":"integer",
            "description":"The unique identifier for an attachment revision.",
            "nullable":true,
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "type":"string",
            "description":"The code that indicates the error status of the attachment.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ContentId":{
            "maxLength":"80",
            "type":"string",
            "description":"The unique identifier of the attachment content.",
            "nullable":false,
            "x-queryable":true
        },
        "RevisionId":{
            "maxLength":"80",
            "type":"string",
            "description":"The unique identifier of the attachment revision.",
            "nullable":false,
            "x-queryable":true
        },
        "RevLabel":{
            "maxLength":"80",
            "type":"string",
            "description":"The label for an attachment revision.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

href: string

Title: hyperlink reference

The URI to the related resource.
kind: string

Title: kind

Allowed Values: [ "collection", "item", "describe", "other" ]

The kind of the related resource.
name: string

Title: name

The name of the link to the related resource.
properties: object properties
rel: string

Title: relation

Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

changeIndicator: string

Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}