Jump to

• Request
• Response

Update an attachment for a registered public user account

patch

/fscmRestApi/resources/11.13.18.05/publicSectorAccountAttachments/{DocumentId}

Request

Path Parameters

• DocumentId(required): integer(int64)
  The unique identifier for the attached document.

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.

Supported Media Types

• application/json

Request Body - application/json ()

The following table describes the body parameters in the request for this task.

Root Schema : schema

Type: object

Show Source

• AttachmentEntityName: string
  Default Value: PSC_DOC_PBL

  The unique name given to an account attachment that is used by the Attachment component.
• CreatedByName: string
  Title: Uploaded By

  The name of the user who created the attachment.
• Description: string
  Title: Description

  Maximum Length: 100

  The description of the attachment.
• DocumentCategory: string
  Maximum Length: 30

  The category for an attached document. The category must be in the Document Group that is specified for registered user accounts. This Document Group is referenced by the REST publicSectorUserSetups.DocGroupId.
• DocumentId: integer (int64)
  The unique identifier for the attached document.
• DocumentSubcategory: string
  Maximum Length: 30

  The subcategory for an attached document. Only active subcategories for the specified document category are allowed.
• PblAttachmentAccessor: array Account Attachment Accessors
  Title: Account Attachment Accessors

  The account attachment accessor resource is used for displaying file-related information such as file name and file URL.
• 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.
• ProfileId: integer (int64)
  The unique identifier for a registered public user account profile.
• PscUserId: integer (int64)
  The unique identifier for a registered public user reference row.
• UpdatedByName: string
  Title: Last Updated By

  The name of the user who last updated the attachment.
• Version: integer (int32)
  Used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.

{
    "type":"object",
    "properties":{
        "CreatedByName":{
            "title":"Uploaded By",
            "type":"string",
            "description":"The name of the user who created the attachment.",
            "nullable":true
        },
        "ProfileId":{
            "type":"integer",
            "description":"The unique identifier for a registered public user account profile.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "DocumentSubcategory":{
            "maxLength":30,
            "type":"string",
            "description":"The subcategory for an attached document. Only active subcategories for the specified document category are allowed.",
            "nullable":true
        },
        "PreviewWidth":{
            "type":"number",
            "description":"This column indicates the width of a stored thumbnail.",
            "nullable":true,
            "x-hints":{
                "precision":8,
                "scale":2
            }
        },
        "PreviewHeight":{
            "type":"number",
            "description":"This column indicates the height of a stored thumbnail.",
            "nullable":true,
            "x-hints":{
                "precision":8,
                "scale":2
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":100,
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true
        },
        "UpdatedByName":{
            "title":"Last Updated By",
            "type":"string",
            "description":"The name of the user who last updated the attachment.",
            "nullable":true
        },
        "PscUserId":{
            "type":"integer",
            "description":"The unique identifier for a registered public user reference row.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "DocumentId":{
            "type":"integer",
            "description":"The unique identifier for the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "Preview":{
            "type":"string",
            "description":"This column contains the thumbnail of an attached file.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "DocumentCategory":{
            "maxLength":30,
            "type":"string",
            "description":"The category for an attached document. The category must be in the Document Group that is specified for registered user accounts. This Document Group is referenced by the REST publicSectorUserSetups.DocGroupId.",
            "nullable":true
        },
        "Version":{
            "type":"integer",
            "description":"Used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":4
            }
        },
        "PblAttachmentAccessor":{
            "title":"Account Attachment Accessors",
            "type":"array",
            "description":"The account attachment accessor resource is used for displaying file-related information such as file name and file URL.",
            "items":{
                "$ref":"#/components/schemas/publicSectorAccountAttachments-PblAttachmentAccessor-item-patch-request"
            }
        },
        "AttachmentEntityName":{
            "type":"string",
            "description":"The unique name given to an account attachment that is used by the Attachment component.",
            "nullable":true,
            "default":"PSC_DOC_PBL"
        }
    }
}

Nested Schema : Account Attachment Accessors

Type: array

Title: Account Attachment Accessors

The account attachment accessor resource is used for displaying file-related information such as file name and file URL.

Show Source

• Array of: object publicSectorAccountAttachments-PblAttachmentAccessor-item-patch-request

{
    "title":"Account Attachment Accessors",
    "type":"array",
    "description":"The account attachment accessor resource is used for displaying file-related information such as file name and file URL.",
    "items":{
        "$ref":"#/components/schemas/publicSectorAccountAttachments-PblAttachmentAccessor-item-patch-request"
    }
}

Nested Schema : publicSectorAccountAttachments-PblAttachmentAccessor-item-patch-request

Type: object

Show Source

• AttachmentsRevision: array Account Attachment Revisions
  Title: Account Attachment Revisions

  The account attachments revision resource is used for displaying the historical information for an attachment.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  The unique name given to the account attachment accessors, 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.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  The datatype 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.
• 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 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 file contents of the attachment.
• 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.
• 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.
• UploadedFileLength: integer
  Title: File Size

  The file length of the attachment in bytes.
• UploadedFileName: string
  Title: Uploaded File Name

  The name of the attached file.
• 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.

{
    "type":"object",
    "properties":{
        "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"
            }
        },
        "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"
            }
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The datatype code of the attachment.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "AttachmentsRevision":{
            "title":"Account Attachment Revisions",
            "type":"array",
            "description":"The account attachments revision resource is used for displaying the historical information for an attachment.",
            "items":{
                "$ref":"#/components/schemas/publicSectorAccountAttachments-PblAttachmentAccessor-AttachmentsRevision-item-patch-request"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name of the attached file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "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"
            }
        },
        "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 file contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment such as text/plain, or csv.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The date of expiration of the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":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"
            }
        },
        "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"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"The folder path of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"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 account attachment accessors, which makes the attachment functionality work in conjunction with the entity name.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The file length of the attachment in bytes.",
            "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"
            }
        }
    }
}

Nested Schema : Account Attachment Revisions

Type: array

Title: Account Attachment Revisions

The account attachments revision resource is used for displaying the historical information for an attachment.

Show Source

• Array of: object publicSectorAccountAttachments-PblAttachmentAccessor-AttachmentsRevision-item-patch-request

{
    "title":"Account Attachment Revisions",
    "type":"array",
    "description":"The account attachments revision resource is used for displaying the historical information for an attachment.",
    "items":{
        "$ref":"#/components/schemas/publicSectorAccountAttachments-PblAttachmentAccessor-AttachmentsRevision-item-patch-request"
    }
}

Nested Schema : publicSectorAccountAttachments-PblAttachmentAccessor-AttachmentsRevision-item-patch-request

Type: object

Show Source

• 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)
  Indicates the date that the file was attached.
• 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
        },
        "InDate":{
            "type":"string",
            "description":"Indicates the date that the file was attached.",
            "format":"date-time",
            "nullable":true
        },
        "Format":{
            "maxLength":128,
            "type":"string",
            "description":"The format of the attachment.",
            "nullable":true
        },
        "UserRevisionId":{
            "type":"integer",
            "description":"The unique identifier for an attachment revision.",
            "nullable":true
        },
        "ErrorStatusCode":{
            "type":"string",
            "description":"The code that indicates the error status of the attachment.",
            "nullable":true,
            "x-queryable":false
        },
        "ContentId":{
            "maxLength":80,
            "type":"string",
            "description":"The unique identifier of the attachment content.",
            "nullable":false
        },
        "RevLabel":{
            "maxLength":80,
            "type":"string",
            "description":"The label for an 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(required):
  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(required):
  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 : publicSectorAccountAttachments-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  Unique identifier for an agency.
• AttachmentEntityName: string
  Default Value: PSC_DOC_PBL

  The unique name given to an account attachment that is used by the Attachment component.
• AttachmentId: integer (int64)
  The attachment ID from the common attachment table.
• AttachmentNewId: integer (int64)
  The attachment ID from the common attachment table.
• AttachmentType: string
  Maximum Length: 15

  Default Value: PBL

  The attachment type. The value is PBL for registered public user account management attachments.
• CreatedByName: string
  Title: Uploaded By

  The name of the user who created the attachment.
• CreationDate: string (date-time)
  Title: Uploaded On

  Read Only: true

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

  Maximum Length: 100

  The description of the attachment.
• DocumentCategory: string
  Maximum Length: 30

  The category for an attached document. The category must be in the Document Group that is specified for registered user accounts. This Document Group is referenced by the REST publicSectorUserSetups.DocGroupId.
• DocumentId: integer (int64)
  The unique identifier for the attached document.
• DocumentSubcategory: string
  Maximum Length: 30

  The subcategory for an attached document. Only active subcategories for the specified document category are allowed.
• FileName: string
  Title: File Name

  Maximum Length: 255

  The name of the attached file.
• FileSize: integer (int64)
  Title: File Size

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

  The type of the attachment file such as text/plain, or image/jpeg.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time that the attachment was last updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PblAttachmentAccessor: array Account Attachment Accessors
  Title: Account Attachment Accessors

  The account attachment accessor resource is used for displaying file-related information such as file name and file URL.
• 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.
• ProfileId: integer (int64)
  The unique identifier for a registered public user account profile.
• ProfileName: string
  Read Only: true

  A transient field for a registered public user account profile name.
• PscUserId: integer (int64)
  The unique identifier for a registered public user reference row.
• UpdatedByName: string
  Title: Last Updated By

  The name of the user who last updated the attachment.
• Version: integer (int32)
  Used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.

{
    "type":"object",
    "properties":{
        "CreatedByName":{
            "title":"Uploaded By",
            "type":"string",
            "description":"The name of the user who created the attachment.",
            "nullable":true,
            "x-queryable":true
        },
        "ProfileId":{
            "type":"integer",
            "description":"The unique identifier for a registered public user account profile.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Uploaded On",
            "type":"string",
            "description":"The date and time that the attachment was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DocumentSubcategory":{
            "maxLength":30,
            "type":"string",
            "description":"The subcategory for an attached document. Only active subcategories for the specified document category are allowed.",
            "nullable":true,
            "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
        },
        "Description":{
            "title":"Description",
            "maxLength":100,
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"Unique identifier for an agency.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "FileName":{
            "title":"File Name",
            "maxLength":255,
            "type":"string",
            "description":"The name of the attached file.",
            "nullable":false,
            "x-queryable":true
        },
        "DocumentId":{
            "type":"integer",
            "description":"The unique identifier for the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ProfileName":{
            "type":"string",
            "description":"A transient field for a registered public user account profile name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DocumentCategory":{
            "maxLength":30,
            "type":"string",
            "description":"The category for an attached document. The category must be in the Document Group that is specified for registered user accounts. This Document Group is referenced by the REST publicSectorUserSetups.DocGroupId.",
            "nullable":true,
            "x-queryable":true
        },
        "Version":{
            "type":"integer",
            "description":"Used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":4
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "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. The value is PBL for registered public user account management attachments.",
            "nullable":true,
            "default":"PBL",
            "x-queryable":true
        },
        "UpdatedByName":{
            "title":"Last Updated By",
            "type":"string",
            "description":"The name of the user who last updated the attachment.",
            "nullable":true,
            "x-queryable":true
        },
        "PscUserId":{
            "type":"integer",
            "description":"The unique identifier for a registered public user reference row.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AttachmentNewId":{
            "type":"integer",
            "description":"The attachment ID from the common attachment table.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Preview":{
            "type":"string",
            "description":"This column contains the thumbnail of an attached file.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "AttachmentId":{
            "type":"integer",
            "description":"The attachment ID from the common attachment table.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "FileType":{
            "maxLength":100,
            "type":"string",
            "description":"The type of the attachment file such as text/plain, or image/jpeg.",
            "nullable":true,
            "x-queryable":true
        },
        "PblAttachmentAccessor":{
            "title":"Account Attachment Accessors",
            "type":"array",
            "description":"The account attachment accessor resource is used for displaying file-related information such as file name and file URL.",
            "items":{
                "$ref":"#/components/schemas/publicSectorAccountAttachments-PblAttachmentAccessor-item-response"
            }
        },
        "AttachmentEntityName":{
            "type":"string",
            "description":"The unique name given to an account attachment that is used by the Attachment component.",
            "nullable":true,
            "default":"PSC_DOC_PBL",
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time that the 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.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "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 : Account Attachment Accessors

Type: array

Title: Account Attachment Accessors

The account attachment accessor resource is used for displaying file-related information such as file name and file URL.

Show Source

• Array of: object publicSectorAccountAttachments-PblAttachmentAccessor-item-response

{
    "title":"Account Attachment Accessors",
    "type":"array",
    "description":"The account attachment accessor resource is used for displaying file-related information such as file name and file URL.",
    "items":{
        "$ref":"#/components/schemas/publicSectorAccountAttachments-PblAttachmentAccessor-item-response"
    }
}

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

Nested Schema : publicSectorAccountAttachments-PblAttachmentAccessor-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  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 attachment document.
• AttachmentsRevision: array Account Attachment Revisions
  Title: Account Attachment Revisions

  The account attachments revision resource is used for displaying the historical information for an attachment.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  The unique name given to the account attachment accessors, 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 that the attachment was created.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  The datatype 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.
• 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 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 file contents of the attachment.
• 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 that 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.
• 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.
• UploadedFileLength: integer
  Title: File Size

  The file length of the attachment in bytes.
• UploadedFileName: string
  Title: Uploaded File Name

  The name of the attached file.
• 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 signing in to the fusion system.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time that 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":"Account Attachment Revisions",
            "type":"array",
            "description":"The account attachments revision resource is used for displaying the historical information for an attachment.",
            "items":{
                "$ref":"#/components/schemas/publicSectorAccountAttachments-PblAttachmentAccessor-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 of the attachment 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.",
            "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 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.",
            "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 signing in to the fusion 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 datatype code of the attachment.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "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.",
            "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 file contents of the attachment.",
            "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.",
            "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 account attachment accessors, 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 that 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":"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 : Account Attachment Revisions

Type: array

Title: Account Attachment Revisions

The account attachments revision resource is used for displaying the historical information for an attachment.

Show Source

• Array of: object publicSectorAccountAttachments-PblAttachmentAccessor-AttachmentsRevision-item-response

{
    "title":"Account Attachment Revisions",
    "type":"array",
    "description":"The account attachments revision resource is used for displaying the historical information for an attachment.",
    "items":{
        "$ref":"#/components/schemas/publicSectorAccountAttachments-PblAttachmentAccessor-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 : publicSectorAccountAttachments-PblAttachmentAccessor-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)
  Indicates the date that 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":"Indicates the date that 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"
    }
}

Links

PblAttachmentAccessor

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorAccountAttachments/{DocumentId}/child/PblAttachmentAccessor

Parameters:

• DocumentId: $request.path.DocumentId

The account attachment accessor resource is used for displaying file-related information such as file name and file URL.

Back to Top