Jump to

• Request
• Response

Update a case attachment

patch

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

Request

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Path Parameters

• AttachmentKey: integer
  The unique identifier of the case attachment.

Body ()

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

Root Schema : publicSectorCaseAttachments-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Title: Agency ID

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

  The public unique identifier of the migrated case record.
• CaseAttachmentAccessor(optional): 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(optional): integer(int64)
  The unique identifier of the case attachment.
• CaseKey(optional): integer(int64)
  The unique identifier of the case.
• CasePuid(optional): string
  Maximum Length: 480

  The public unique identifier of the migrated case attachment record.
• CreatedByName(optional): string
  Title: Uploaded By

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

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

  Maximum Length: 100

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

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

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

  Maximum Length: 255

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

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

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

  The name of the user who last updated the row.
• links(optional): array Items
  Title: Items

  Link Relations
• UpdatedByName(optional): string
  Title: Last Updated By

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

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The identifier of the agency for the case attachment.",
            "title":"Agency ID"
        },
        "AttachmentEntityName":{
            "type":"string",
            "description":"The entity name of the case attachment."
        },
        "AttachmentId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the case attachment."
        },
        "AttachmentKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the case attachment."
        },
        "AttachmentPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier of the migrated case record."
        },
        "CaseAttachmentAccessor":{
            "items":{
                "$ref":"#/definitions/publicSectorCaseAttachments-CaseAttachmentAccessor-item"
            },
            "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.",
            "title":"Case Attachment Contents"
        },
        "CaseAttachmentId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the case attachment."
        },
        "CaseKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the case."
        },
        "CasePuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier of the migrated case attachment record."
        },
        "CreatedByName":{
            "type":"string",
            "description":"The name of the user who created the attachment.",
            "title":"Uploaded By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was created.",
            "title":"Uploaded On"
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"The description of the case attachment.",
            "title":"Description"
        },
        "DocumentCategory":{
            "maxLength":30,
            "type":"string",
            "description":"The document category of the case attachment."
        },
        "DocumentSubcategory":{
            "maxLength":30,
            "type":"string",
            "description":"The document subcategory of the case attachment."
        },
        "FileName":{
            "maxLength":255,
            "type":"string",
            "description":"The name of the case attachment file.",
            "title":"File Name"
        },
        "FileSize":{
            "format":"int64",
            "type":"integer",
            "description":"File size of the case attachment.",
            "title":"File Size"
        },
        "FileType":{
            "maxLength":100,
            "type":"string",
            "description":"File type of the case attachment."
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "title":"Last Updated Date"
        },
        "UpdatedByName":{
            "type":"string",
            "description":"The name of the user who last updated the attachment.",
            "title":"Last Updated By"
        },
        "Version":{
            "format":"int32",
            "type":"integer",
            "description":"The version of the case attachment."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

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

{
    "items":{
        "$ref":"#/definitions/publicSectorCaseAttachments-CaseAttachmentAccessor-item"
    },
    "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.",
    "title":"Case Attachment Contents"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : publicSectorCaseAttachments-CaseAttachmentAccessor-item

Type: object

Show Source

• AsyncTrackerId(optional): string
  Title: Asynchronous Upload Tracker Id

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

  The unique identifier of the case attachment content.
• AttachmentsRevision(optional): 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(optional): string
  Title: Category

  Maximum Length: 30

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

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

  Maximum Length: 255

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

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

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

  Maximum Length: 30

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

  Maximum Length: 255

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

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

  Maximum Length: 1000

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

  The document version number for the case attachment content.
• ErrorStatusCode(optional): string
  Title: Error Status Code

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

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

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

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

  Maximum Length: 2048

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

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

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

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

  Maximum Length: 255

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

  The name of the user who last updated the row.
• links(optional): array Items
  Title: Items

  Link Relations
• Title(optional): string
  Title: Title

  The title of the case attachment content.
• UploadedFileContentType(optional): string
  Title: Uploaded File Content Type

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

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

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

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

  Maximum Length: 4000

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

  Maximum Length: 4000

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

  Maximum Length: 255

  The username for the case attachment content.

{
    "properties":{
        "AsyncTrackerId":{
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "title":"Asynchronous Upload Tracker Id"
        },
        "AttachedDocumentId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the case attachment content.",
            "title":"Attached Document Id"
        },
        "AttachmentsRevision":{
            "items":{
                "$ref":"#/definitions/publicSectorCaseAttachments-CaseAttachmentAccessor-AttachmentsRevision-item"
            },
            "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.",
            "title":"Case Attachment Revisions"
        },
        "CategoryName":{
            "maxLength":30,
            "type":"string",
            "description":"The category name of the case attachment content.",
            "title":"Category"
        },
        "ContentRepositoryFileShared":{
            "type":"boolean",
            "description":"The content repository file for the case attachment content.",
            "title":"Shared"
        },
        "CreatedBy":{
            "maxLength":255,
            "type":"string",
            "description":"The name of the user who created the row.",
            "title":"Created By"
        },
        "CreatedByUserName":{
            "type":"string",
            "description":"The name of the user who created the row.",
            "title":"Created By User Name"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was created.",
            "title":"Creation Date"
        },
        "DatatypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"The date type code of the case attachment content.",
            "title":"Type"
        },
        "Description":{
            "maxLength":255,
            "type":"string",
            "description":"The description of the case attachment content.",
            "title":"Description"
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"The document identifier of the case attachment content."
        },
        "DmFolderPath":{
            "maxLength":1000,
            "type":"string",
            "description":"The path of the folder that contains the case attachment content.",
            "title":"Dm Folder Path"
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The document version number for the case attachment content."
        },
        "ErrorStatusCode":{
            "type":"string",
            "description":"The error status code for the case attachment content.",
            "title":"Error Status Code"
        },
        "ErrorStatusMessage":{
            "type":"string",
            "description":"The error status message for the case attachment content.",
            "title":"Error Status Message"
        },
        "ExpirationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The expiration date of the case attachment content.",
            "title":"Expiration Date"
        },
        "FileContents":{
            "format":"binary",
            "type":"string",
            "description":"The contents of the case attachment file.",
            "title":"File Contents"
        },
        "FileName":{
            "maxLength":2048,
            "type":"string",
            "description":"File name for the case attachment content.",
            "title":"File Name"
        },
        "FileUrl":{
            "type":"string",
            "description":"The URL of the file that contains the case attachment content.",
            "title":"File Url"
        },
        "FileWebImage":{
            "format":"binary",
            "type":"string",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "title":"File Web Image"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "title":"Last Update Date"
        },
        "LastUpdatedBy":{
            "maxLength":255,
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "title":"Last Updated By"
        },
        "LastUpdatedByUserName":{
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "title":"Last Updated By User"
        },
        "Title":{
            "type":"string",
            "description":"The title of the case attachment content.",
            "title":"Title"
        },
        "UploadedFileContentType":{
            "type":"string",
            "description":"The uploaded file content type of the case attachment content.",
            "title":"Uploaded File Content Type"
        },
        "UploadedFileLength":{
            "format":"int64",
            "type":"integer",
            "description":"The length of the file used for the uploaded case attachment content.",
            "title":"File Size"
        },
        "UploadedFileName":{
            "type":"string",
            "description":"The name of the uploaded file that contains the case attachment content.",
            "title":"Uploaded File Name"
        },
        "UploadedText":{
            "type":"string",
            "description":"The uploaded text in the case attachment content.",
            "title":"Uploaded Text"
        },
        "Uri":{
            "maxLength":4000,
            "type":"string",
            "description":"The URI of the case attachment content.",
            "title":"Uri"
        },
        "Url":{
            "maxLength":4000,
            "type":"string",
            "description":"The URL of the case attachment content.",
            "title":"Url"
        },
        "UserName":{
            "maxLength":255,
            "type":"string",
            "description":"The username for the case attachment content.",
            "title":"User Name"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

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

{
    "items":{
        "$ref":"#/definitions/publicSectorCaseAttachments-CaseAttachmentAccessor-AttachmentsRevision-item"
    },
    "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.",
    "title":"Case Attachment Revisions"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : publicSectorCaseAttachments-CaseAttachmentAccessor-AttachmentsRevision-item

Type: object

Show Source

• AttachedDocumentId(optional): integer(int64)
  The unique identifier of the case attachment content.
• ContentId(optional): string
  Maximum Length: 80

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

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

  Link Relations
• RevisionId(optional): string
  Maximum Length: 80

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

  The revision label of the attachment revision.
• UserRevisionId(optional): integer(int64)
  The user revision ID for the attachment revision.

{
    "properties":{
        "AttachedDocumentId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the case attachment content."
        },
        "ContentId":{
            "maxLength":80,
            "type":"string",
            "description":"The contents of the attachment revision."
        },
        "ErrorStatusCode":{
            "type":"string",
            "description":"The error status code of the case attachment revision."
        },
        "ErrorStatusMessage":{
            "type":"string",
            "description":"The error status message of the case attachment revision."
        },
        "FileUrl":{
            "type":"string",
            "description":"The file URL of the case attachment revision."
        },
        "Format":{
            "maxLength":128,
            "type":"string",
            "description":"The format of the attachment revision."
        },
        "InDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date of the attachment revision."
        },
        "RevLabel":{
            "maxLength":80,
            "type":"string",
            "description":"The revision label of the attachment revision."
        },
        "RevisionId":{
            "maxLength":80,
            "type":"string",
            "description":"The ID of the attachment revision."
        },
        "UserRevisionId":{
            "format":"int64",
            "type":"integer",
            "description":"The user revision ID for the attachment revision."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

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

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorCaseAttachments-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Title: Agency ID

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

  The public unique identifier of the migrated case record.
• CaseAttachmentAccessor(optional): 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(optional): integer(int64)
  The unique identifier of the case attachment.
• CaseKey(optional): integer(int64)
  The unique identifier of the case.
• CasePuid(optional): string
  Maximum Length: 480

  The public unique identifier of the migrated case attachment record.
• CreatedByName(optional): string
  Title: Uploaded By

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

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

  Maximum Length: 100

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

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

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

  Maximum Length: 255

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

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

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

  The name of the user who last updated the row.
• links(optional): array Items
  Title: Items

  Link Relations
• UpdatedByName(optional): string
  Title: Last Updated By

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

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The identifier of the agency for the case attachment.",
            "title":"Agency ID"
        },
        "AttachmentEntityName":{
            "type":"string",
            "description":"The entity name of the case attachment."
        },
        "AttachmentId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the case attachment."
        },
        "AttachmentKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the case attachment."
        },
        "AttachmentPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier of the migrated case record."
        },
        "CaseAttachmentAccessor":{
            "items":{
                "$ref":"#/definitions/publicSectorCaseAttachments-CaseAttachmentAccessor-item"
            },
            "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.",
            "title":"Case Attachment Contents"
        },
        "CaseAttachmentId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the case attachment."
        },
        "CaseKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the case."
        },
        "CasePuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier of the migrated case attachment record."
        },
        "CreatedByName":{
            "type":"string",
            "description":"The name of the user who created the attachment.",
            "title":"Uploaded By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was created.",
            "title":"Uploaded On"
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"The description of the case attachment.",
            "title":"Description"
        },
        "DocumentCategory":{
            "maxLength":30,
            "type":"string",
            "description":"The document category of the case attachment."
        },
        "DocumentSubcategory":{
            "maxLength":30,
            "type":"string",
            "description":"The document subcategory of the case attachment."
        },
        "FileName":{
            "maxLength":255,
            "type":"string",
            "description":"The name of the case attachment file.",
            "title":"File Name"
        },
        "FileSize":{
            "format":"int64",
            "type":"integer",
            "description":"File size of the case attachment.",
            "title":"File Size"
        },
        "FileType":{
            "maxLength":100,
            "type":"string",
            "description":"File type of the case attachment."
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "title":"Last Updated Date"
        },
        "UpdatedByName":{
            "type":"string",
            "description":"The name of the user who last updated the attachment.",
            "title":"Last Updated By"
        },
        "Version":{
            "format":"int32",
            "type":"integer",
            "description":"The version of the case attachment."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

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

{
    "items":{
        "$ref":"#/definitions/publicSectorCaseAttachments-CaseAttachmentAccessor-item"
    },
    "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.",
    "title":"Case Attachment Contents"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : publicSectorCaseAttachments-CaseAttachmentAccessor-item

Type: object

Show Source

• AsyncTrackerId(optional): string
  Title: Asynchronous Upload Tracker Id

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

  The unique identifier of the case attachment content.
• AttachmentsRevision(optional): 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(optional): string
  Title: Category

  Maximum Length: 30

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

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

  Maximum Length: 255

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

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

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

  Maximum Length: 30

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

  Maximum Length: 255

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

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

  Maximum Length: 1000

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

  The document version number for the case attachment content.
• ErrorStatusCode(optional): string
  Title: Error Status Code

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

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

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

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

  Maximum Length: 2048

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

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

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

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

  Maximum Length: 255

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

  The name of the user who last updated the row.
• links(optional): array Items
  Title: Items

  Link Relations
• Title(optional): string
  Title: Title

  The title of the case attachment content.
• UploadedFileContentType(optional): string
  Title: Uploaded File Content Type

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

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

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

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

  Maximum Length: 4000

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

  Maximum Length: 4000

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

  Maximum Length: 255

  The username for the case attachment content.

{
    "properties":{
        "AsyncTrackerId":{
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "title":"Asynchronous Upload Tracker Id"
        },
        "AttachedDocumentId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the case attachment content.",
            "title":"Attached Document Id"
        },
        "AttachmentsRevision":{
            "items":{
                "$ref":"#/definitions/publicSectorCaseAttachments-CaseAttachmentAccessor-AttachmentsRevision-item"
            },
            "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.",
            "title":"Case Attachment Revisions"
        },
        "CategoryName":{
            "maxLength":30,
            "type":"string",
            "description":"The category name of the case attachment content.",
            "title":"Category"
        },
        "ContentRepositoryFileShared":{
            "type":"boolean",
            "description":"The content repository file for the case attachment content.",
            "title":"Shared"
        },
        "CreatedBy":{
            "maxLength":255,
            "type":"string",
            "description":"The name of the user who created the row.",
            "title":"Created By"
        },
        "CreatedByUserName":{
            "type":"string",
            "description":"The name of the user who created the row.",
            "title":"Created By User Name"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was created.",
            "title":"Creation Date"
        },
        "DatatypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"The date type code of the case attachment content.",
            "title":"Type"
        },
        "Description":{
            "maxLength":255,
            "type":"string",
            "description":"The description of the case attachment content.",
            "title":"Description"
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"The document identifier of the case attachment content."
        },
        "DmFolderPath":{
            "maxLength":1000,
            "type":"string",
            "description":"The path of the folder that contains the case attachment content.",
            "title":"Dm Folder Path"
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The document version number for the case attachment content."
        },
        "ErrorStatusCode":{
            "type":"string",
            "description":"The error status code for the case attachment content.",
            "title":"Error Status Code"
        },
        "ErrorStatusMessage":{
            "type":"string",
            "description":"The error status message for the case attachment content.",
            "title":"Error Status Message"
        },
        "ExpirationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The expiration date of the case attachment content.",
            "title":"Expiration Date"
        },
        "FileContents":{
            "format":"binary",
            "type":"string",
            "description":"The contents of the case attachment file.",
            "title":"File Contents"
        },
        "FileName":{
            "maxLength":2048,
            "type":"string",
            "description":"File name for the case attachment content.",
            "title":"File Name"
        },
        "FileUrl":{
            "type":"string",
            "description":"The URL of the file that contains the case attachment content.",
            "title":"File Url"
        },
        "FileWebImage":{
            "format":"binary",
            "type":"string",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "title":"File Web Image"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "title":"Last Update Date"
        },
        "LastUpdatedBy":{
            "maxLength":255,
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "title":"Last Updated By"
        },
        "LastUpdatedByUserName":{
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "title":"Last Updated By User"
        },
        "Title":{
            "type":"string",
            "description":"The title of the case attachment content.",
            "title":"Title"
        },
        "UploadedFileContentType":{
            "type":"string",
            "description":"The uploaded file content type of the case attachment content.",
            "title":"Uploaded File Content Type"
        },
        "UploadedFileLength":{
            "format":"int64",
            "type":"integer",
            "description":"The length of the file used for the uploaded case attachment content.",
            "title":"File Size"
        },
        "UploadedFileName":{
            "type":"string",
            "description":"The name of the uploaded file that contains the case attachment content.",
            "title":"Uploaded File Name"
        },
        "UploadedText":{
            "type":"string",
            "description":"The uploaded text in the case attachment content.",
            "title":"Uploaded Text"
        },
        "Uri":{
            "maxLength":4000,
            "type":"string",
            "description":"The URI of the case attachment content.",
            "title":"Uri"
        },
        "Url":{
            "maxLength":4000,
            "type":"string",
            "description":"The URL of the case attachment content.",
            "title":"Url"
        },
        "UserName":{
            "maxLength":255,
            "type":"string",
            "description":"The username for the case attachment content.",
            "title":"User Name"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

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

{
    "items":{
        "$ref":"#/definitions/publicSectorCaseAttachments-CaseAttachmentAccessor-AttachmentsRevision-item"
    },
    "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.",
    "title":"Case Attachment Revisions"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : publicSectorCaseAttachments-CaseAttachmentAccessor-AttachmentsRevision-item

Type: object

Show Source

• AttachedDocumentId(optional): integer(int64)
  The unique identifier of the case attachment content.
• ContentId(optional): string
  Maximum Length: 80

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

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

  Link Relations
• RevisionId(optional): string
  Maximum Length: 80

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

  The revision label of the attachment revision.
• UserRevisionId(optional): integer(int64)
  The user revision ID for the attachment revision.

{
    "properties":{
        "AttachedDocumentId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the case attachment content."
        },
        "ContentId":{
            "maxLength":80,
            "type":"string",
            "description":"The contents of the attachment revision."
        },
        "ErrorStatusCode":{
            "type":"string",
            "description":"The error status code of the case attachment revision."
        },
        "ErrorStatusMessage":{
            "type":"string",
            "description":"The error status message of the case attachment revision."
        },
        "FileUrl":{
            "type":"string",
            "description":"The file URL of the case attachment revision."
        },
        "Format":{
            "maxLength":128,
            "type":"string",
            "description":"The format of the attachment revision."
        },
        "InDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date of the attachment revision."
        },
        "RevLabel":{
            "maxLength":80,
            "type":"string",
            "description":"The revision label of the attachment revision."
        },
        "RevisionId":{
            "maxLength":80,
            "type":"string",
            "description":"The ID of the attachment revision."
        },
        "UserRevisionId":{
            "format":"int64",
            "type":"integer",
            "description":"The user revision ID for the attachment revision."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

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

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top