Jump to

• Request
• Response

Update an attachment

patch

/fscmRestApi/resources/11.13.18.05/publicSectorIntakeAttachments/{AttachmentKey}

Request

Supported Media Types

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

Path Parameters

• AttachmentKey: integer
  The key of the attachment.

Body ()

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

Root Schema : publicSectorIntakeAttachments-item

Type: object

Discriminator: AttachmentType

Show Source

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

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

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

  The attachment type.
• AttXrefPuid(optional): string
  Maximum Length: 480

  The public unique identifier for a migrated parent record.
• CreatedByName(optional): string
  Title: Uploaded By

  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 attachment description.
• DocCategory(optional): string
  Maximum Length: 30

  The document category.
• DocOriginator(optional): string
  Maximum Length: 50

  The document originator.
• DocSubcategory(optional): string
  Maximum Length: 30

  The document subcategory.
• FileName(optional): string
  Title: File Name

  Maximum Length: 255

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

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

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

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

  The date and time when the row was last updated.
• links(optional): array Items
  Title: Items

  Link Relations
• TransactionKey(optional): integer(int64)
  The transaction key.
• TransactionType(optional): string
  Maximum Length: 15

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

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

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The agency ID.",
            "title":"Agency ID"
        },
        "AttXrefPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier for a migrated parent record."
        },
        "AttachmentEntityName":{
            "type":"string",
            "description":"The attachment entity name."
        },
        "AttachmentId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the attachment."
        },
        "AttachmentKey":{
            "format":"int64",
            "type":"integer",
            "description":"The key of the attachment."
        },
        "AttachmentPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier for a migrated attachment record."
        },
        "AttachmentType":{
            "maxLength":15,
            "type":"string",
            "description":"The attachment type."
        },
        "CreatedByName":{
            "type":"string",
            "description":"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 attachment description.",
            "title":"Description"
        },
        "DocCategory":{
            "maxLength":30,
            "type":"string",
            "description":"The document category."
        },
        "DocOriginator":{
            "maxLength":50,
            "type":"string",
            "description":"The document originator."
        },
        "DocSubcategory":{
            "maxLength":30,
            "type":"string",
            "description":"The document subcategory."
        },
        "FileName":{
            "maxLength":255,
            "type":"string",
            "description":"The filename of the attachment.",
            "title":"File Name"
        },
        "FileSize":{
            "format":"int64",
            "type":"integer",
            "description":"The file size of the attachment.",
            "title":"File Size"
        },
        "FileType":{
            "maxLength":100,
            "type":"string",
            "description":"The file type of the attachment."
        },
        "IntakeAgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The intake agency ID."
        },
        "IntakeAttachmentId":{
            "format":"int64",
            "type":"integer",
            "description":"The intake attachment ID."
        },
        "IntakeAttachmentViewAccessor":{
            "items":{
                "$ref":"#/definitions/publicSectorIntakeAttachments-IntakeAttachmentViewAccessor-item"
            },
            "type":"array",
            "description":"The attachment view accessors resource is used to view, create, and update attachments.",
            "title":"Attachment View Accessors"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "title":"Last Updated Date"
        },
        "TransactionKey":{
            "format":"int64",
            "type":"integer",
            "description":"The transaction key."
        },
        "TransactionType":{
            "maxLength":15,
            "type":"string",
            "description":"The transaction type."
        },
        "UpdatedByName":{
            "type":"string",
            "description":"The user who last updated the attachment.",
            "title":"Last Updated By"
        },
        "Version":{
            "format":"int32",
            "type":"integer",
            "description":"The version of the attachment."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "required":[
        "AttachmentType"
    ],
    "discriminator":"AttachmentType",
    "type":"object"
}

Nested Schema : Attachment View Accessors

Type: array

Title: Attachment View Accessors

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

Show Source

• Array of: object publicSectorIntakeAttachments-IntakeAttachmentViewAccessor-item

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

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 : publicSectorIntakeAttachments-IntakeAttachmentViewAccessor-item

Type: object

Show Source

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

  The 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 attached document.
• AttachmentsRevision(optional): array Attachment Revisions
  Title: Attachment Revisions

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

  Maximum Length: 30

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

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

  Maximum Length: 255

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

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

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

  Maximum Length: 30

  A value that indicates the data type.
• Description(optional): string
  Title: Description

  Maximum Length: 255

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

  The document ID from which the attachment is created.
• DmFolderPath(optional): string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path from which the attachment is created.
• DmVersionNumber(optional): string
  Maximum Length: 255

  The document version number from which the attachment is created.
• ErrorStatusCode(optional): string
  Title: Error Status Code

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

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

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

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

  Maximum Length: 2048

  The filename of the attachment.
• FileUrl(optional): string
  Title: File Url

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

  Maximum Length: 255

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

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

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

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

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

  The size of the attachment file.
• UploadedFileName(optional): string
  Title: Uploaded File Name

  The name to assign to a new attachment file.
• UploadedText(optional): string
  Title: Uploaded Text

  The text content for a new text attachment.
• Uri(optional): string
  Title: Uri

  Maximum Length: 4000

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

  Maximum Length: 4000

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

  Maximum Length: 255

  The login credentials of the user who created the attachment.

{
    "properties":{
        "AsyncTrackerId":{
            "type":"string",
            "description":"The 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 attached document.",
            "title":"Attached Document Id"
        },
        "AttachmentsRevision":{
            "items":{
                "$ref":"#/definitions/publicSectorIntakeAttachments-IntakeAttachmentViewAccessor-AttachmentsRevision-item"
            },
            "type":"array",
            "description":"The attachment revisions resource is used to view attachment revisions.",
            "title":"Attachment Revisions"
        },
        "CategoryName":{
            "maxLength":30,
            "type":"string",
            "description":"The category of the attachment.",
            "title":"Category"
        },
        "ContentRepositoryFileShared":{
            "type":"boolean",
            "description":"Indicates whether the attachment is shared. The default value is false.",
            "title":"Shared"
        },
        "CreatedBy":{
            "maxLength":255,
            "type":"string",
            "description":"The user who created the record.",
            "title":"Created By"
        },
        "CreatedByUserName":{
            "type":"string",
            "description":"The user name who created the record.",
            "title":"Created By User Name"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the record was created.",
            "title":"Creation Date"
        },
        "DatatypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"A value that indicates the data type.",
            "title":"Type"
        },
        "Description":{
            "maxLength":255,
            "type":"string",
            "description":"The description of the attachment.",
            "title":"Description"
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"The document ID from which the attachment is created."
        },
        "DmFolderPath":{
            "maxLength":1000,
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "title":"Dm Folder Path"
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The document version number from which the attachment is created."
        },
        "ErrorStatusCode":{
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "title":"Error Status Code"
        },
        "ErrorStatusMessage":{
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "title":"Error Status Message"
        },
        "ExpirationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "title":"Expiration Date"
        },
        "FileContents":{
            "format":"binary",
            "type":"string",
            "description":"The contents of the attachment.",
            "title":"File Contents"
        },
        "FileName":{
            "maxLength":2048,
            "type":"string",
            "description":"The filename of the attachment.",
            "title":"File Name"
        },
        "FileUrl":{
            "type":"string",
            "description":"The URI of the file.",
            "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 when the record was last updated.",
            "title":"Last Update Date"
        },
        "LastUpdatedBy":{
            "maxLength":255,
            "type":"string",
            "description":"The user who last updated the record.",
            "title":"Last Updated By"
        },
        "LastUpdatedByUserName":{
            "type":"string",
            "description":"The user name who last updated the record.",
            "title":"Last Updated By User"
        },
        "Title":{
            "type":"string",
            "description":"The title of the attachment.",
            "title":"Title"
        },
        "UploadedFileContentType":{
            "type":"string",
            "description":"The content type of the attachment.",
            "title":"Uploaded File Content Type"
        },
        "UploadedFileLength":{
            "format":"int64",
            "type":"integer",
            "description":"The size of the attachment file.",
            "title":"File Size"
        },
        "UploadedFileName":{
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "title":"Uploaded File Name"
        },
        "UploadedText":{
            "type":"string",
            "description":"The text content for a new text attachment.",
            "title":"Uploaded Text"
        },
        "Uri":{
            "maxLength":4000,
            "type":"string",
            "description":"The URI of a Topology Manager type attachment.",
            "title":"Uri"
        },
        "Url":{
            "maxLength":4000,
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "title":"Url"
        },
        "UserName":{
            "maxLength":255,
            "type":"string",
            "description":"The login credentials of the user who created the attachment.",
            "title":"User Name"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Attachment Revisions

Type: array

Title: Attachment Revisions

The attachment revisions resource is used to view attachment revisions.

Show Source

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

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

Type: object

Show Source

• AttachedDocumentId(optional): integer(int64)
  The unique identifier of the attached document for this revision.
• ContentId(optional): string
  Maximum Length: 80

  The contents of the attachment revision.
• ErrorStatusCode(optional): string
  The error code, if any, for the attachment revision.
• ErrorStatusMessage(optional): string
  The error message, if any, for the attachment revision.
• FileUrl(optional): string
  The filename of the 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 attached document for this revision."
        },
        "ContentId":{
            "maxLength":80,
            "type":"string",
            "description":"The contents of the attachment revision."
        },
        "ErrorStatusCode":{
            "type":"string",
            "description":"The error code, if any, for the attachment revision."
        },
        "ErrorStatusMessage":{
            "type":"string",
            "description":"The error message, if any, for the attachment revision."
        },
        "FileUrl":{
            "type":"string",
            "description":"The filename of the 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 : publicSectorIntakeAttachments-item

Type: object

Discriminator: AttachmentType

Show Source

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

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

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

  The attachment type.
• AttXrefPuid(optional): string
  Maximum Length: 480

  The public unique identifier for a migrated parent record.
• CreatedByName(optional): string
  Title: Uploaded By

  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 attachment description.
• DocCategory(optional): string
  Maximum Length: 30

  The document category.
• DocOriginator(optional): string
  Maximum Length: 50

  The document originator.
• DocSubcategory(optional): string
  Maximum Length: 30

  The document subcategory.
• FileName(optional): string
  Title: File Name

  Maximum Length: 255

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

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

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

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

  The date and time when the row was last updated.
• links(optional): array Items
  Title: Items

  Link Relations
• TransactionKey(optional): integer(int64)
  The transaction key.
• TransactionType(optional): string
  Maximum Length: 15

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

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

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The agency ID.",
            "title":"Agency ID"
        },
        "AttXrefPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier for a migrated parent record."
        },
        "AttachmentEntityName":{
            "type":"string",
            "description":"The attachment entity name."
        },
        "AttachmentId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the attachment."
        },
        "AttachmentKey":{
            "format":"int64",
            "type":"integer",
            "description":"The key of the attachment."
        },
        "AttachmentPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier for a migrated attachment record."
        },
        "AttachmentType":{
            "maxLength":15,
            "type":"string",
            "description":"The attachment type."
        },
        "CreatedByName":{
            "type":"string",
            "description":"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 attachment description.",
            "title":"Description"
        },
        "DocCategory":{
            "maxLength":30,
            "type":"string",
            "description":"The document category."
        },
        "DocOriginator":{
            "maxLength":50,
            "type":"string",
            "description":"The document originator."
        },
        "DocSubcategory":{
            "maxLength":30,
            "type":"string",
            "description":"The document subcategory."
        },
        "FileName":{
            "maxLength":255,
            "type":"string",
            "description":"The filename of the attachment.",
            "title":"File Name"
        },
        "FileSize":{
            "format":"int64",
            "type":"integer",
            "description":"The file size of the attachment.",
            "title":"File Size"
        },
        "FileType":{
            "maxLength":100,
            "type":"string",
            "description":"The file type of the attachment."
        },
        "IntakeAgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The intake agency ID."
        },
        "IntakeAttachmentId":{
            "format":"int64",
            "type":"integer",
            "description":"The intake attachment ID."
        },
        "IntakeAttachmentViewAccessor":{
            "items":{
                "$ref":"#/definitions/publicSectorIntakeAttachments-IntakeAttachmentViewAccessor-item"
            },
            "type":"array",
            "description":"The attachment view accessors resource is used to view, create, and update attachments.",
            "title":"Attachment View Accessors"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "title":"Last Updated Date"
        },
        "TransactionKey":{
            "format":"int64",
            "type":"integer",
            "description":"The transaction key."
        },
        "TransactionType":{
            "maxLength":15,
            "type":"string",
            "description":"The transaction type."
        },
        "UpdatedByName":{
            "type":"string",
            "description":"The user who last updated the attachment.",
            "title":"Last Updated By"
        },
        "Version":{
            "format":"int32",
            "type":"integer",
            "description":"The version of the attachment."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "required":[
        "AttachmentType"
    ],
    "discriminator":"AttachmentType",
    "type":"object"
}

Nested Schema : Attachment View Accessors

Type: array

Title: Attachment View Accessors

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

Show Source

• Array of: object publicSectorIntakeAttachments-IntakeAttachmentViewAccessor-item

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

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 : publicSectorIntakeAttachments-IntakeAttachmentViewAccessor-item

Type: object

Show Source

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

  The 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 attached document.
• AttachmentsRevision(optional): array Attachment Revisions
  Title: Attachment Revisions

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

  Maximum Length: 30

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

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

  Maximum Length: 255

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

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

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

  Maximum Length: 30

  A value that indicates the data type.
• Description(optional): string
  Title: Description

  Maximum Length: 255

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

  The document ID from which the attachment is created.
• DmFolderPath(optional): string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path from which the attachment is created.
• DmVersionNumber(optional): string
  Maximum Length: 255

  The document version number from which the attachment is created.
• ErrorStatusCode(optional): string
  Title: Error Status Code

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

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

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

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

  Maximum Length: 2048

  The filename of the attachment.
• FileUrl(optional): string
  Title: File Url

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

  Maximum Length: 255

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

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

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

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

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

  The size of the attachment file.
• UploadedFileName(optional): string
  Title: Uploaded File Name

  The name to assign to a new attachment file.
• UploadedText(optional): string
  Title: Uploaded Text

  The text content for a new text attachment.
• Uri(optional): string
  Title: Uri

  Maximum Length: 4000

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

  Maximum Length: 4000

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

  Maximum Length: 255

  The login credentials of the user who created the attachment.

{
    "properties":{
        "AsyncTrackerId":{
            "type":"string",
            "description":"The 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 attached document.",
            "title":"Attached Document Id"
        },
        "AttachmentsRevision":{
            "items":{
                "$ref":"#/definitions/publicSectorIntakeAttachments-IntakeAttachmentViewAccessor-AttachmentsRevision-item"
            },
            "type":"array",
            "description":"The attachment revisions resource is used to view attachment revisions.",
            "title":"Attachment Revisions"
        },
        "CategoryName":{
            "maxLength":30,
            "type":"string",
            "description":"The category of the attachment.",
            "title":"Category"
        },
        "ContentRepositoryFileShared":{
            "type":"boolean",
            "description":"Indicates whether the attachment is shared. The default value is false.",
            "title":"Shared"
        },
        "CreatedBy":{
            "maxLength":255,
            "type":"string",
            "description":"The user who created the record.",
            "title":"Created By"
        },
        "CreatedByUserName":{
            "type":"string",
            "description":"The user name who created the record.",
            "title":"Created By User Name"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the record was created.",
            "title":"Creation Date"
        },
        "DatatypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"A value that indicates the data type.",
            "title":"Type"
        },
        "Description":{
            "maxLength":255,
            "type":"string",
            "description":"The description of the attachment.",
            "title":"Description"
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"The document ID from which the attachment is created."
        },
        "DmFolderPath":{
            "maxLength":1000,
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "title":"Dm Folder Path"
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The document version number from which the attachment is created."
        },
        "ErrorStatusCode":{
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "title":"Error Status Code"
        },
        "ErrorStatusMessage":{
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "title":"Error Status Message"
        },
        "ExpirationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "title":"Expiration Date"
        },
        "FileContents":{
            "format":"binary",
            "type":"string",
            "description":"The contents of the attachment.",
            "title":"File Contents"
        },
        "FileName":{
            "maxLength":2048,
            "type":"string",
            "description":"The filename of the attachment.",
            "title":"File Name"
        },
        "FileUrl":{
            "type":"string",
            "description":"The URI of the file.",
            "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 when the record was last updated.",
            "title":"Last Update Date"
        },
        "LastUpdatedBy":{
            "maxLength":255,
            "type":"string",
            "description":"The user who last updated the record.",
            "title":"Last Updated By"
        },
        "LastUpdatedByUserName":{
            "type":"string",
            "description":"The user name who last updated the record.",
            "title":"Last Updated By User"
        },
        "Title":{
            "type":"string",
            "description":"The title of the attachment.",
            "title":"Title"
        },
        "UploadedFileContentType":{
            "type":"string",
            "description":"The content type of the attachment.",
            "title":"Uploaded File Content Type"
        },
        "UploadedFileLength":{
            "format":"int64",
            "type":"integer",
            "description":"The size of the attachment file.",
            "title":"File Size"
        },
        "UploadedFileName":{
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "title":"Uploaded File Name"
        },
        "UploadedText":{
            "type":"string",
            "description":"The text content for a new text attachment.",
            "title":"Uploaded Text"
        },
        "Uri":{
            "maxLength":4000,
            "type":"string",
            "description":"The URI of a Topology Manager type attachment.",
            "title":"Uri"
        },
        "Url":{
            "maxLength":4000,
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "title":"Url"
        },
        "UserName":{
            "maxLength":255,
            "type":"string",
            "description":"The login credentials of the user who created the attachment.",
            "title":"User Name"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Attachment Revisions

Type: array

Title: Attachment Revisions

The attachment revisions resource is used to view attachment revisions.

Show Source

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

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

Type: object

Show Source

• AttachedDocumentId(optional): integer(int64)
  The unique identifier of the attached document for this revision.
• ContentId(optional): string
  Maximum Length: 80

  The contents of the attachment revision.
• ErrorStatusCode(optional): string
  The error code, if any, for the attachment revision.
• ErrorStatusMessage(optional): string
  The error message, if any, for the attachment revision.
• FileUrl(optional): string
  The filename of the 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 attached document for this revision."
        },
        "ContentId":{
            "maxLength":80,
            "type":"string",
            "description":"The contents of the attachment revision."
        },
        "ErrorStatusCode":{
            "type":"string",
            "description":"The error code, if any, for the attachment revision."
        },
        "ErrorStatusMessage":{
            "type":"string",
            "description":"The error message, if any, for the attachment revision."
        },
        "FileUrl":{
            "type":"string",
            "description":"The filename of the 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