Jump to

• Request
• Response

Update a case attachment

patch

/fscmRestApi/resources/11.13.18.05/publicSectorCaseAttachments/{AttachmentKey}

Request

Path Parameters

• AttachmentKey(required): integer(int64)
  The unique identifier of the case attachment.

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 ()

Root Schema : schema

Type: object

Show Source

• AttachmentEntityName: string
  Default Value: PSC_DOC_CASE

  The entity name of the case attachment.
• CaseAttachmentAccessor: array Case Attachment Contents
  Title: Case Attachment Contents

  The case attachment content resource is used to view, create, or modify the content of a case attachment. Case attachments are used in Code Enforcement cases.
• 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 name of the user who created the attachment.
• Description: string
  Title: Description

  Maximum Length: 100

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

  The document category of the case attachment.
• DocumentSubcategory: string
  Maximum Length: 30

  The document subcategory of the case attachment.
• 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.
• UpdatedByName: string
  Title: Last Updated By

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

{
    "type":"object",
    "properties":{
        "CreatedByName":{
            "title":"Uploaded By",
            "type":"string",
            "description":"The name of 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
        },
        "DocumentSubcategory":{
            "maxLength":"30",
            "type":"string",
            "description":"The document subcategory of the case attachment.",
            "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"
            }
        },
        "CaseAttachmentAccessor":{
            "title":"Case Attachment Contents",
            "type":"array",
            "description":"The case attachment content resource is used to view, create, or modify the content of a case attachment. Case attachments are used in Code Enforcement cases.",
            "items":{
                "$ref":"#/components/schemas/publicSectorCaseAttachments-CaseAttachmentAccessor-item-patch-request"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":"100",
            "type":"string",
            "description":"The description of the case attachment.",
            "nullable":true
        },
        "UpdatedByName":{
            "title":"Last Updated By",
            "type":"string",
            "description":"The name of the user who last updated the attachment.",
            "nullable":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 document category of the case attachment.",
            "nullable":true
        },
        "Version":{
            "type":"integer",
            "description":"The version of the case attachment.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"4"
            }
        },
        "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
        },
        "AttachmentEntityName":{
            "type":"string",
            "description":"The entity name of the case attachment.",
            "nullable":true,
            "default":"PSC_DOC_CASE"
        }
    }
}

Nested Schema : Case Attachment Contents

Type: array

Title: Case Attachment Contents

The case attachment content resource is used to view, create, or modify the content of a case attachment. Case attachments are used in Code Enforcement cases.

Show Source

• Array of: object publicSectorCaseAttachments-CaseAttachmentAccessor-item-patch-request

{
    "title":"Case Attachment Contents",
    "type":"array",
    "description":"The case attachment content resource is used to view, create, or modify the content of a case attachment. Case attachments are used in Code Enforcement cases.",
    "items":{
        "$ref":"#/components/schemas/publicSectorCaseAttachments-CaseAttachmentAccessor-item-patch-request"
    }
}

Nested Schema : publicSectorCaseAttachments-CaseAttachmentAccessor-item-patch-request

Type: object

Show Source

• AttachmentsRevision: array Case Attachment Revisions
  Title: Case Attachment Revisions

  The case attachment revision resource is used to view, create, or modify a case attachment revision. Case attachments are used in Code Enforcement cases.
• CategoryName: string
  Title: Category

  Maximum Length: 30

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

  The content repository file for the case attachment content.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  The date type code of the case attachment content.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the case attachment content.
• DmDocumentId: string
  Maximum Length: 255

  The document identifier of the case attachment content.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The path of the folder that contains the case attachment content.
• DmVersionNumber: string
  Maximum Length: 255

  The document version number for the case attachment content.
• DownloadInfo: string
  Title: DownloadInfo

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

  The error status code for the case attachment content.
• ErrorStatusMessage: string
  Title: Error Status Message

  The error status message for the case attachment content.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  The expiration date of the case attachment content.
• FileContents: string (byte)
  Title: File Contents

  The contents of the case attachment file.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  File name for the case attachment content.
• FileUrl: string
  Title: File Url

  The URL of the file that contains the case attachment content.
• 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 case attachment content.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  The uploaded file content type of the case attachment content.
• UploadedFileLength: integer
  Title: File Size

  The length of the file used for the uploaded case attachment content.
• UploadedFileName: string
  Title: Uploaded File Name

  The name of the uploaded file that contains the case attachment content.
• UploadedText: string
  Title: Uploaded Text

  The uploaded text in the case attachment content.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of the case attachment content.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of the case attachment content.

{
    "type":"object",
    "properties":{
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error status message for the case attachment content.",
            "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 case attachment content.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"The date type code of the case attachment content.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"2048",
            "type":"string",
            "description":"File name for the case attachment content.",
            "nullable":true,
            "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 case attachment content.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "AttachmentsRevision":{
            "title":"Case Attachment Revisions",
            "type":"array",
            "description":"The case attachment revision resource is used to view, create, or modify a case attachment revision. Case attachments are used in Code Enforcement cases.",
            "items":{
                "$ref":"#/components/schemas/publicSectorCaseAttachments-CaseAttachmentAccessor-AttachmentsRevision-item-patch-request"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":"4000",
            "type":"string",
            "description":"The URI of the case attachment content.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Url":{
            "title":"Url",
            "maxLength":"4000",
            "type":"string",
            "description":"The URL of the case attachment content.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name of the uploaded file that contains the case attachment content.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"The document identifier of the case attachment content.",
            "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 of the file that contains the case attachment content.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"The content repository file for the case attachment content.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the case attachment file.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The uploaded file content type of the case attachment content.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the case attachment content.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error status code for the case attachment content.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"The JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":"1000",
            "type":"string",
            "description":"The path of the folder that contains the case attachment content.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The uploaded text in the case attachment content.",
            "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 name of the case attachment content.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The length of the file used for the uploaded case attachment content.",
            "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 for the case attachment content.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        }
    }
}

Nested Schema : Case Attachment Revisions

Type: array

Title: Case Attachment Revisions

The case attachment revision resource is used to view, create, or modify a case attachment revision. Case attachments are used in Code Enforcement cases.

Show Source

• Array of: object publicSectorCaseAttachments-CaseAttachmentAccessor-AttachmentsRevision-item-patch-request

{
    "title":"Case Attachment Revisions",
    "type":"array",
    "description":"The case attachment revision resource is used to view, create, or modify a case attachment revision. Case attachments are used in Code Enforcement cases.",
    "items":{
        "$ref":"#/components/schemas/publicSectorCaseAttachments-CaseAttachmentAccessor-AttachmentsRevision-item-patch-request"
    }
}

Nested Schema : publicSectorCaseAttachments-CaseAttachmentAccessor-AttachmentsRevision-item-patch-request

Type: object

Show Source

• ContentId: string
  Maximum Length: 80

  The contents of the attachment revision.
• ErrorStatusCode: string
  The error status code of the case attachment revision.
• ErrorStatusMessage: string
  The error status message of the case attachment revision.
• FileUrl: string
  The file URL of the case attachment revision.
• Format: string
  Maximum Length: 128

  The format of the attachment revision.
• InDate: string (date-time)
  The date 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 file URL of the case attachment revision.",
            "nullable":true,
            "x-queryable":false
        },
        "ErrorStatusMessage":{
            "type":"string",
            "description":"The error status message of the case 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 status code of the case attachment revision.",
            "nullable":true,
            "x-queryable":false
        },
        "ContentId":{
            "maxLength":"80",
            "type":"string",
            "description":"The contents 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 : publicSectorCaseAttachments-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  The identifier of the agency for the case attachment.
• AttachmentEntityName: string
  Default Value: PSC_DOC_CASE

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

  The public unique identifier of the migrated case record.
• CaseAttachmentAccessor: array Case Attachment Contents
  Title: Case Attachment Contents

  The case attachment content resource is used to view, create, or modify the content of a case attachment. Case attachments are used in Code Enforcement cases.
• CaseAttachmentId: integer (int64)
  The unique identifier of the case attachment.
• CaseKey: integer (int64)
  The unique identifier of the case.
• CasePuid: string
  Maximum Length: 480

  The public unique identifier of the migrated case attachment 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 name of the user who created the attachment.
• CreatedByUserType: string
  Maximum Length: 15

  Default Value: ORA_A

  The type of user who created the case 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 description of the case attachment.
• DocumentCategory: string
  Maximum Length: 30

  The document category of the case attachment.
• DocumentSubcategory: string
  Maximum Length: 30

  The document subcategory of the case attachment.
• FileName: string
  Title: File Name

  Maximum Length: 255

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

  File size of the case attachment.
• FileType: string
  Maximum Length: 100

  File type of the case attachment.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The name of the user who last updated the row.
• 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.
• UpdatedByName: string
  Title: Last Updated By

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

{
    "type":"object",
    "properties":{
        "CreatedByName":{
            "title":"Uploaded By",
            "type":"string",
            "description":"The name of 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
        },
        "DocumentSubcategory":{
            "maxLength":"30",
            "type":"string",
            "description":"The document subcategory of the case attachment.",
            "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
        },
        "CaseAttachmentAccessor":{
            "title":"Case Attachment Contents",
            "type":"array",
            "description":"The case attachment content resource is used to view, create, or modify the content of a case attachment. Case attachments are used in Code Enforcement cases.",
            "items":{
                "$ref":"#/components/schemas/publicSectorCaseAttachments-CaseAttachmentAccessor-item-response"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":"100",
            "type":"string",
            "description":"The description of the case attachment.",
            "nullable":true,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The identifier of the agency for the case attachment.",
            "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 case attachment file.",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedByUserType":{
            "maxLength":"15",
            "type":"string",
            "description":"The type of user who created the case attachment.",
            "nullable":true,
            "default":"ORA_A",
            "x-queryable":true
        },
        "CasePuid":{
            "maxLength":"480",
            "type":"string",
            "description":"The public unique identifier of the migrated case attachment record.",
            "nullable":false,
            "x-queryable":true
        },
        "DocumentCategory":{
            "maxLength":"30",
            "type":"string",
            "description":"The document category of the case attachment.",
            "nullable":true,
            "x-queryable":true
        },
        "AttachmentKey":{
            "type":"integer",
            "description":"The unique identifier of the case attachment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "Version":{
            "type":"integer",
            "description":"The version of the case attachment.",
            "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
        },
        "CaseKey":{
            "type":"integer",
            "description":"The unique identifier of the case.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "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
        },
        "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 unique identifier of the case attachment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "FileType":{
            "maxLength":"100",
            "type":"string",
            "description":"File type of the case attachment.",
            "nullable":true,
            "x-queryable":true
        },
        "CaseAttachmentId":{
            "type":"integer",
            "description":"The unique identifier of the case attachment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "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
        },
        "AttachmentEntityName":{
            "type":"string",
            "description":"The entity name of the case attachment.",
            "nullable":true,
            "default":"PSC_DOC_CASE",
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FileSize":{
            "title":"File Size",
            "type":"integer",
            "description":"File size of the case attachment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AttachmentPuid":{
            "maxLength":"480",
            "type":"string",
            "description":"The public unique identifier of the migrated case record.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Case Attachment Contents

Type: array

Title: Case Attachment Contents

The case attachment content resource is used to view, create, or modify the content of a case attachment. Case attachments are used in Code Enforcement cases.

Show Source

• Array of: object publicSectorCaseAttachments-CaseAttachmentAccessor-item-response

{
    "title":"Case Attachment Contents",
    "type":"array",
    "description":"The case attachment content resource is used to view, create, or modify the content of a case attachment. Case attachments are used in Code Enforcement cases.",
    "items":{
        "$ref":"#/components/schemas/publicSectorCaseAttachments-CaseAttachmentAccessor-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 : publicSectorCaseAttachments-CaseAttachmentAccessor-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 case attachment content.
• AttachmentsRevision: array Case Attachment Revisions
  Title: Case Attachment Revisions

  The case attachment revision resource is used to view, create, or modify a case attachment revision. Case attachments are used in Code Enforcement cases.
• CategoryName: string
  Title: Category

  Maximum Length: 30

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

  The content repository file for the case attachment content.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  The name of the user who created the row.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

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

  Read Only: true

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

  Maximum Length: 30

  Default Value: FILE

  The date type code of the case attachment content.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the case attachment content.
• DmDocumentId: string
  Maximum Length: 255

  The document identifier of the case attachment content.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The path of the folder that contains the case attachment content.
• DmVersionNumber: string
  Maximum Length: 255

  The document version number for the case attachment content.
• DownloadInfo: string
  Title: DownloadInfo

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

  The error status code for the case attachment content.
• ErrorStatusMessage: string
  Title: Error Status Message

  The error status message for the case attachment content.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  The expiration date of the case attachment content.
• FileContents: string (byte)
  Title: File Contents

  The contents of the case attachment file.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  File name for the case attachment content.
• FileUrl: string
  Title: File Url

  The URL of the file that contains the case attachment content.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

  The base64 encoded image of the file displayed in .png format if the source is a convertible image.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date and time when the row was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

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

  Read Only: true

  The name of the user who last updated the row.
• 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 case attachment content.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  The uploaded file content type of the case attachment content.
• UploadedFileLength: integer
  Title: File Size

  The length of the file used for the uploaded case attachment content.
• UploadedFileName: string
  Title: Uploaded File Name

  The name of the uploaded file that contains the case attachment content.
• UploadedText: string
  Title: Uploaded Text

  The uploaded text in the case attachment content.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of the case attachment content.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of the case attachment content.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  The username for the case attachment content.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the row 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 case attachment content.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"2048",
            "type":"string",
            "description":"File name for the case attachment content.",
            "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":"Case Attachment Revisions",
            "type":"array",
            "description":"The case attachment revision resource is used to view, create, or modify a case attachment revision. Case attachments are used in Code Enforcement cases.",
            "items":{
                "$ref":"#/components/schemas/publicSectorCaseAttachments-CaseAttachmentAccessor-AttachmentsRevision-item-response"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":"4000",
            "type":"string",
            "description":"The URI of the case attachment content.",
            "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 the case attachment content.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"The document identifier of the case attachment content.",
            "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 case attachment content.",
            "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 uploaded file content type of the case attachment content.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"The JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"The name of the user who created the row.",
            "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 length of the file used for the uploaded case attachment content.",
            "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 for the case attachment content.",
            "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 name of the user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error status message for the case attachment content.",
            "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 username for the case attachment content.",
            "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 name of the user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"The date type code of the case attachment content.",
            "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 case attachment content.",
            "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 name of the user who last updated the row.",
            "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 uploaded file that contains the case attachment content.",
            "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 that contains the case attachment content.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"The content repository file for the case attachment content.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the case attachment file.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the case attachment content.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error status code for the case attachment content.",
            "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 path of the folder that contains the case attachment content.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The uploaded text in the case attachment content.",
            "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 name of the case attachment content.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date and time when the row 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 : Case Attachment Revisions

Type: array

Title: Case Attachment Revisions

The case attachment revision resource is used to view, create, or modify a case attachment revision. Case attachments are used in Code Enforcement cases.

Show Source

• Array of: object publicSectorCaseAttachments-CaseAttachmentAccessor-AttachmentsRevision-item-response

{
    "title":"Case Attachment Revisions",
    "type":"array",
    "description":"The case attachment revision resource is used to view, create, or modify a case attachment revision. Case attachments are used in Code Enforcement cases.",
    "items":{
        "$ref":"#/components/schemas/publicSectorCaseAttachments-CaseAttachmentAccessor-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 : publicSectorCaseAttachments-CaseAttachmentAccessor-AttachmentsRevision-item-response

Type: object

Show Source

• AttachedDocumentId: string
  Read Only: true

  The unique identifier of the case attachment content.
• ContentId: string
  Maximum Length: 80

  The contents of the attachment revision.
• ErrorStatusCode: string
  The error status code of the case attachment revision.
• ErrorStatusMessage: string
  The error status message of the case attachment revision.
• FileUrl: string
  The file URL of the case 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 file URL of the case attachment revision.",
            "nullable":true,
            "x-queryable":false
        },
        "ErrorStatusMessage":{
            "type":"string",
            "description":"The error status message of the case attachment revision.",
            "nullable":true,
            "x-queryable":false
        },
        "AttachedDocumentId":{
            "type":"string",
            "description":"The unique identifier of the case attachment content.",
            "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 status code of the case 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

CaseAttachmentAccessor

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorCaseAttachments/{AttachmentKey}/child/CaseAttachmentAccessor

Parameters:

• AttachmentKey: $request.path.AttachmentKey

The case attachment content resource is used to view, create, or modify the content of a case attachment. Case attachments are used in Code Enforcement cases.

Back to Top