Jump to

• Request
• Response

Create an attachment

post

/fscmRestApi/resources/11.13.18.05/publicSectorIntakeAttachments

Request

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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  The agency ID.
• AttachmentEntityName: string
  Default Value: PSC_DOC_INCIDENT

  The attachment entity name.
• AttachmentId: integer (int64)
  The unique identifier of the attachment.
• AttachmentKey: integer (int64)
  The key of the attachment.
• AttachmentPuid: string
  Maximum Length: 480

  Default Value:

  The public unique identifier for a migrated attachment record.
• AttachmentType: string
  Maximum Length: 15

  Default Value: INC

  The attachment type.
• AttXrefPuid: string
  Maximum Length: 480

  Default Value:

  The public unique identifier for a migrated parent record.
• 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 attachment.
• Description: string
  Title: Description

  Maximum Length: 100

  The attachment description.
• DocCategory: string
  Maximum Length: 30

  The document category.
• DocOriginator: string
  Maximum Length: 50

  The document originator.
• DocSubcategory: string
  Maximum Length: 30

  The document subcategory.
• 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(required): string
  Title: File Name

  Maximum Length: 255

  The filename of the attachment.
• FileSize(required): integer (int64)
  Title: File Size

  The file size of the attachment.
• FileType: string
  Maximum Length: 100

  The file type of the attachment.
• IntakeAgencyId(required): integer (int32)
  The intake agency ID.
• IntakeAttachmentId(required): integer (int64)
  The intake attachment ID.
• IntakeAttachmentViewAccessor: array Attachment View Accessors
  Title: Attachment View Accessors

  The attachment view accessors resource is used to view, create, and update attachments.
• Preview: string (byte)
  This column contains the thumbnail of an attached file.
• PreviewHeight: number
  This column indicates the height of a stored thumbnail.
• PreviewWidth: number
  This column indicates the width of a stored thumbnail.
• RequiredFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates whether the attachment is a required document. The default value is N for no.
• TransactionKey(required): integer (int64)
  The transaction key.
• TransactionType(required): string
  Maximum Length: 15

  The transaction type.
• UpdatedByName: string
  Title: Last Updated By

  The user who last updated the attachment.
• Version(required): integer (int32)
  The version of the attachment.

{
    "required":[
        "FileName",
        "FileSize",
        "IntakeAgencyId",
        "IntakeAttachmentId",
        "TransactionKey",
        "TransactionType",
        "Version"
    ],
    "type":"object",
    "properties":{
        "CreatedByName":{
            "title":"Uploaded By",
            "type":"string",
            "description":"The user who created the attachment.",
            "nullable":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
        },
        "IntakeAttachmentId":{
            "type":"integer",
            "description":"The intake attachment ID.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "PreviewHeight":{
            "type":"number",
            "description":"This column indicates the height of a stored thumbnail.",
            "nullable":true,
            "x-hints":{
                "precision":"8",
                "scale":"2"
            }
        },
        "TransactionType":{
            "maxLength":"15",
            "type":"string",
            "description":"The transaction type.",
            "nullable":false
        },
        "Description":{
            "title":"Description",
            "maxLength":"100",
            "type":"string",
            "description":"The attachment description.",
            "nullable":true
        },
        "TransactionKey":{
            "type":"integer",
            "description":"The transaction key.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The agency ID.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"255",
            "type":"string",
            "description":"The filename of the attachment.",
            "nullable":false
        },
        "AttachmentKey":{
            "type":"integer",
            "description":"The key of the attachment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "Version":{
            "type":"integer",
            "description":"The version of the attachment.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"4"
            }
        },
        "AttXrefPuid":{
            "maxLength":"480",
            "type":"string",
            "description":"The public unique identifier for a migrated parent record.",
            "nullable":false,
            "default":" "
        },
        "DocCategory":{
            "maxLength":"30",
            "type":"string",
            "description":"The document category.",
            "nullable":true
        },
        "DocSubcategory":{
            "maxLength":"30",
            "type":"string",
            "description":"The document subcategory.",
            "nullable":true
        },
        "PreviewWidth":{
            "type":"number",
            "description":"This column indicates the width of a stored thumbnail.",
            "nullable":true,
            "x-hints":{
                "precision":"8",
                "scale":"2"
            }
        },
        "AttachmentType":{
            "maxLength":"15",
            "type":"string",
            "description":"The attachment type.",
            "nullable":true,
            "default":"INC"
        },
        "UpdatedByName":{
            "title":"Last Updated By",
            "type":"string",
            "description":"The user who last updated the attachment.",
            "nullable":true
        },
        "IntakeAgencyId":{
            "type":"integer",
            "description":"The intake agency ID.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"8"
            }
        },
        "Preview":{
            "type":"string",
            "description":"This column contains the thumbnail of an attached file.",
            "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
        },
        "AttachmentId":{
            "type":"integer",
            "description":"The unique identifier of the attachment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "IntakeAttachmentViewAccessor":{
            "title":"Attachment View Accessors",
            "type":"array",
            "description":"The attachment view accessors resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/publicSectorIntakeAttachments-IntakeAttachmentViewAccessor-item-post-request"
            }
        },
        "FileType":{
            "maxLength":"100",
            "type":"string",
            "description":"The file type of the attachment.",
            "nullable":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
        },
        "DocOriginator":{
            "maxLength":"50",
            "type":"string",
            "description":"The document originator.",
            "nullable":true
        },
        "AttachmentEntityName":{
            "type":"string",
            "description":"The attachment entity name.",
            "nullable":true,
            "default":"PSC_DOC_INCIDENT"
        },
        "FileSize":{
            "title":"File Size",
            "type":"integer",
            "description":"The file size of the attachment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "AttachmentPuid":{
            "maxLength":"480",
            "type":"string",
            "description":"The public unique identifier for a migrated attachment record.",
            "nullable":false,
            "default":" "
        }
    }
}

Nested Schema : Attachment View Accessors

Type: array

Title: Attachment View Accessors

The attachment view accessors resource is used to view, create, and update attachments.

Show Source

• Array of: object publicSectorIntakeAttachments-IntakeAttachmentViewAccessor-item-post-request

{
    "title":"Attachment View Accessors",
    "type":"array",
    "description":"The attachment view accessors resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/publicSectorIntakeAttachments-IntakeAttachmentViewAccessor-item-post-request"
    }
}

Nested Schema : publicSectorIntakeAttachments-IntakeAttachmentViewAccessor-item-post-request

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

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

  The unique identifier of the attached document.
• AttachmentsRevision: array Attachment Revisions
  Title: Attachment Revisions

  The attachment revisions resource is used to view attachment revisions.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  The category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared. The default value is false.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  A value that indicates the data type.
• 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 from which the attachment is created.
• DmVersionNumber: string
  Maximum Length: 255

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

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  The error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  The error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  The expiration date of the contents in 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 filename of the attachment.
• FileUrl: string
  Title: File Url

  The URL of the file.
• 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 content for a new text attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of a Topology Manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of a web page type attachment.

{
    "type":"object",
    "properties":{
        "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 filename of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "AttachmentsRevision":{
            "title":"Attachment Revisions",
            "type":"array",
            "description":"The attachment revisions resource is used to view attachment revisions.",
            "items":{
                "$ref":"#/components/schemas/publicSectorIntakeAttachments-IntakeAttachmentViewAccessor-AttachmentsRevision-item-post-request"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":"4000",
            "type":"string",
            "description":"The URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Url":{
            "title":"Url",
            "maxLength":"4000",
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"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"
            }
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"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":"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"
            }
        },
        "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"
            }
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"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"
            }
        },
        "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 of the 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 attachment 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 expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for 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 from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text 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 category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"The attribute provided for the 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 Revisions

Type: array

Title: Attachment Revisions

The attachment revisions resource is used to view attachment revisions.

Show Source

• Array of: object publicSectorIntakeAttachments-IntakeAttachmentViewAccessor-AttachmentsRevision-item-post-request

{
    "title":"Attachment Revisions",
    "type":"array",
    "description":"The attachment revisions resource is used to view attachment revisions.",
    "items":{
        "$ref":"#/components/schemas/publicSectorIntakeAttachments-IntakeAttachmentViewAccessor-AttachmentsRevision-item-post-request"
    }
}

Nested Schema : publicSectorIntakeAttachments-IntakeAttachmentViewAccessor-AttachmentsRevision-item-post-request

Type: object

Show Source

• ContentId: string
  Maximum Length: 80

  The contents of the attachment revision.
• ErrorStatusCode: string
  The error code, if any, for the attachment revision.
• ErrorStatusMessage: string
  The error message, if any, for the attachment revision.
• FileUrl: string
  The filename of the attachment revision.
• Format: string
  Maximum Length: 128

  The format of the attachment revision.
• InDate: string (date-time)
  The date of the attachment revision.
• RevisionId: string
  Maximum Length: 80

  The ID of the attachment revision.
• RevLabel: string
  Maximum Length: 80

  The revision label of the attachment revision.
• UserRevisionId: integer
  The user revision ID for the attachment revision.

{
    "type":"object",
    "properties":{
        "FileUrl":{
            "type":"string",
            "description":"The filename of the attachment revision.",
            "nullable":true,
            "x-queryable":false
        },
        "ErrorStatusMessage":{
            "type":"string",
            "description":"The error message, if any, for the attachment revision.",
            "nullable":true,
            "x-queryable":false
        },
        "InDate":{
            "type":"string",
            "description":"The date of the attachment revision.",
            "format":"date-time",
            "nullable":true
        },
        "Format":{
            "maxLength":"128",
            "type":"string",
            "description":"The format of the attachment revision.",
            "nullable":true
        },
        "UserRevisionId":{
            "type":"integer",
            "description":"The user revision ID for the attachment revision.",
            "nullable":true
        },
        "ErrorStatusCode":{
            "type":"string",
            "description":"The error code, if any, for the attachment revision.",
            "nullable":true,
            "x-queryable":false
        },
        "ContentId":{
            "maxLength":"80",
            "type":"string",
            "description":"The contents of the attachment revision.",
            "nullable":false
        },
        "RevisionId":{
            "maxLength":"80",
            "type":"string",
            "description":"The ID of the attachment revision.",
            "nullable":false
        },
        "RevLabel":{
            "maxLength":"80",
            "type":"string",
            "description":"The revision label of the attachment revision.",
            "nullable":true
        }
    }
}

Back to Top

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.

Body ()

Root Schema : publicSectorIntakeAttachments-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  The agency ID.
• AttachmentEntityName: string
  Default Value: PSC_DOC_INCIDENT

  The attachment entity name.
• AttachmentId: integer (int64)
  The unique identifier of the attachment.
• AttachmentKey: integer (int64)
  The key of the attachment.
• AttachmentPuid: string
  Maximum Length: 480

  Default Value:

  The public unique identifier for a migrated attachment record.
• AttachmentType: string
  Maximum Length: 15

  Default Value: INC

  The attachment type.
• AttXrefPuid: string
  Maximum Length: 480

  Default Value:

  The public unique identifier for a migrated parent record.
• 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 attachment.
• CreationDate: string (date-time)
  Title: Uploaded On

  Read Only: true

  The date and time when the row was created.
• Description: string
  Title: Description

  Maximum Length: 100

  The attachment description.
• DocCategory: string
  Maximum Length: 30

  The document category.
• DocOriginator: string
  Maximum Length: 50

  The document originator.
• DocSubcategory: string
  Maximum Length: 30

  The document subcategory.
• 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 filename of the attachment.
• FileSize: integer (int64)
  Title: File Size

  The file size of the attachment.
• FileType: string
  Maximum Length: 100

  The file type of the attachment.
• IntakeAgencyId: integer (int32)
  The intake agency ID.
• IntakeAttachmentId: integer (int64)
  The intake attachment ID.
• IntakeAttachmentViewAccessor: array Attachment View Accessors
  Title: Attachment View Accessors

  The attachment view accessors resource is used to view, create, and update attachments.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the row was last updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Preview: string (byte)
  This column contains the thumbnail of an attached file.
• PreviewHeight: number
  This column indicates the height of a stored thumbnail.
• PreviewWidth: number
  This column indicates the width of a stored thumbnail.
• RequiredFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates whether the attachment is a required document. The default value is N for no.
• TransactionKey: integer (int64)
  The transaction key.
• TransactionType: string
  Maximum Length: 15

  The transaction type.
• UpdatedByName: string
  Title: Last Updated By

  The user who last updated the attachment.
• Version: integer (int32)
  The version of the attachment.

{
    "type":"object",
    "properties":{
        "CreatedByName":{
            "title":"Uploaded By",
            "type":"string",
            "description":"The user who created the attachment.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Uploaded On",
            "type":"string",
            "description":"The date and time when the row 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
        },
        "IntakeAttachmentId":{
            "type":"integer",
            "description":"The intake attachment ID.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PreviewHeight":{
            "type":"number",
            "description":"This column indicates the height of a stored thumbnail.",
            "nullable":true,
            "x-hints":{
                "precision":"8",
                "scale":"2"
            },
            "x-queryable":true
        },
        "TransactionType":{
            "maxLength":"15",
            "type":"string",
            "description":"The transaction type.",
            "nullable":false,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"100",
            "type":"string",
            "description":"The attachment description.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionKey":{
            "type":"integer",
            "description":"The transaction key.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The agency ID.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"255",
            "type":"string",
            "description":"The filename of the attachment.",
            "nullable":false,
            "x-queryable":true
        },
        "AttachmentKey":{
            "type":"integer",
            "description":"The key of the attachment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "Version":{
            "type":"integer",
            "description":"The version of the attachment.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"4"
            },
            "x-queryable":true
        },
        "AttXrefPuid":{
            "maxLength":"480",
            "type":"string",
            "description":"The public unique identifier for a migrated parent record.",
            "nullable":false,
            "default":" ",
            "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.",
            "nullable":true,
            "x-queryable":true
        },
        "DocSubcategory":{
            "maxLength":"30",
            "type":"string",
            "description":"The document subcategory.",
            "nullable":true,
            "x-queryable":true
        },
        "PreviewWidth":{
            "type":"number",
            "description":"This column indicates the width of a stored thumbnail.",
            "nullable":true,
            "x-hints":{
                "precision":"8",
                "scale":"2"
            },
            "x-queryable":true
        },
        "AttachmentType":{
            "maxLength":"15",
            "type":"string",
            "description":"The attachment type.",
            "nullable":true,
            "default":"INC",
            "x-queryable":true
        },
        "UpdatedByName":{
            "title":"Last Updated By",
            "type":"string",
            "description":"The user who last updated the attachment.",
            "nullable":true,
            "x-queryable":true
        },
        "IntakeAgencyId":{
            "type":"integer",
            "description":"The intake agency ID.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "Preview":{
            "type":"string",
            "description":"This column contains the thumbnail of an attached file.",
            "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.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "IntakeAttachmentViewAccessor":{
            "title":"Attachment View Accessors",
            "type":"array",
            "description":"The attachment view accessors resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/publicSectorIntakeAttachments-IntakeAttachmentViewAccessor-item-response"
            }
        },
        "FileType":{
            "maxLength":"100",
            "type":"string",
            "description":"The file type of the attachment.",
            "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
        },
        "DocOriginator":{
            "maxLength":"50",
            "type":"string",
            "description":"The document originator.",
            "nullable":true,
            "x-queryable":true
        },
        "AttachmentEntityName":{
            "type":"string",
            "description":"The attachment entity name.",
            "nullable":true,
            "default":"PSC_DOC_INCIDENT",
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the row 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.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AttachmentPuid":{
            "maxLength":"480",
            "type":"string",
            "description":"The public unique identifier for a migrated attachment record.",
            "nullable":false,
            "default":" ",
            "x-queryable":true
        }
    }
}

Nested Schema : Attachment View Accessors

Type: array

Title: Attachment View Accessors

The attachment view accessors resource is used to view, create, and update attachments.

Show Source

• Array of: object publicSectorIntakeAttachments-IntakeAttachmentViewAccessor-item-response

{
    "title":"Attachment View Accessors",
    "type":"array",
    "description":"The attachment view accessors resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/publicSectorIntakeAttachments-IntakeAttachmentViewAccessor-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 : publicSectorIntakeAttachments-IntakeAttachmentViewAccessor-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

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

  The unique identifier of the attached document.
• AttachmentsRevision: array Attachment Revisions
  Title: Attachment Revisions

  The attachment revisions resource is used to view attachment revisions.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  The category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared. The default value is false.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  The user who created the record.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  The user name who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  A value that indicates the data type.
• 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 from which the attachment is created.
• DmVersionNumber: string
  Maximum Length: 255

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

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  The error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  The error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  The expiration date of the contents in 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 filename of the attachment.
• FileUrl: string
  Title: File Url

  The URL of the 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 when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  The user who last updated the record.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  The user name who last updated the record.
• 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 content for a new text attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of a Topology Manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of a web page type attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  The login credentials of the user who created the attachment.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record 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 filename of the attachment.",
            "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 Revisions",
            "type":"array",
            "description":"The attachment revisions resource is used to view attachment revisions.",
            "items":{
                "$ref":"#/components/schemas/publicSectorIntakeAttachments-IntakeAttachmentViewAccessor-AttachmentsRevision-item-response"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":"4000",
            "type":"string",
            "description":"The URI of a Topology Manager type attachment.",
            "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 of a web page type 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 of the attached document.",
            "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":"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 name who created the record.",
            "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 record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for 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 login credentials of the user who created the attachment.",
            "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 record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"A value that indicates the data type.",
            "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 name who last updated the record.",
            "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 of the 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 attachment 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 expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for 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 from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text 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 category of the attachment.",
            "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 when the record 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 the 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 Revisions

Type: array

Title: Attachment Revisions

The attachment revisions resource is used to view attachment revisions.

Show Source

• Array of: object publicSectorIntakeAttachments-IntakeAttachmentViewAccessor-AttachmentsRevision-item-response

{
    "title":"Attachment Revisions",
    "type":"array",
    "description":"The attachment revisions resource is used to view attachment revisions.",
    "items":{
        "$ref":"#/components/schemas/publicSectorIntakeAttachments-IntakeAttachmentViewAccessor-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 : publicSectorIntakeAttachments-IntakeAttachmentViewAccessor-AttachmentsRevision-item-response

Type: object

Show Source

• AttachedDocumentId: string
  Read Only: true

  The unique identifier of the attached document for this revision.
• ContentId: string
  Maximum Length: 80

  The contents of the attachment revision.
• ErrorStatusCode: string
  The error code, if any, for the attachment revision.
• ErrorStatusMessage: string
  The error message, if any, for the attachment revision.
• FileUrl: string
  The filename of the attachment revision.
• Format: string
  Maximum Length: 128

  The format of the attachment revision.
• InDate: string (date-time)
  The date of the attachment revision.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RevisionId: string
  Maximum Length: 80

  The ID of the attachment revision.
• RevLabel: string
  Maximum Length: 80

  The revision label of the attachment revision.
• UserRevisionId: integer
  The user revision ID for the attachment revision.

{
    "type":"object",
    "properties":{
        "FileUrl":{
            "type":"string",
            "description":"The filename of the attachment revision.",
            "nullable":true,
            "x-queryable":false
        },
        "ErrorStatusMessage":{
            "type":"string",
            "description":"The error message, if any, for the attachment revision.",
            "nullable":true,
            "x-queryable":false
        },
        "AttachedDocumentId":{
            "type":"string",
            "description":"The unique identifier of the attached document for this revision.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "InDate":{
            "type":"string",
            "description":"The date of the attachment revision.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "Format":{
            "maxLength":"128",
            "type":"string",
            "description":"The format of the attachment revision.",
            "nullable":true,
            "x-queryable":true
        },
        "UserRevisionId":{
            "type":"integer",
            "description":"The user revision ID for the attachment revision.",
            "nullable":true,
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "type":"string",
            "description":"The error code, if any, for the attachment revision.",
            "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 contents of the attachment revision.",
            "nullable":false,
            "x-queryable":true
        },
        "RevisionId":{
            "maxLength":"80",
            "type":"string",
            "description":"The ID of the attachment revision.",
            "nullable":false,
            "x-queryable":true
        },
        "RevLabel":{
            "maxLength":"80",
            "type":"string",
            "description":"The revision label of the 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."
        }
    }
}

Links

IntakeAttachmentViewAccessor

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorIntakeAttachments/{AttachmentKey}/child/IntakeAttachmentViewAccessor

Parameters:

• AttachmentKey: $request.path.AttachmentKey

The attachment view accessors resource is used to view, create, and update attachments.

Back to Top