Jump to

• Request
• Response

Update an attachment for a registered public user account

patch

/fscmRestApi/resources/11.13.18.05/publicSectorWebformAttachments/{DocumentKey}

Request

Supported Media Types

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

Path Parameters

• DocumentKey: integer
  The unique identifier for the attached document.

Body ()

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

Root Schema : publicSectorWebformAttachments-item

Type: object

Discriminator: AttachmentType

Show Source

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

  The unique identifier of the agency associated with the web form attached document.
• AttachmentEntityName(optional): string
  Maximum Length: 255

  The unique name given to a web form attachment that is used by the attachment component.
• AttachmentId(optional): integer(int64)
  The attachment ID from the common attachment table.
• AttachmentIdXref(optional): integer(int64)
  The cross-reference transaction's attachment identifier.
• AttachmentType: string
  Maximum Length: 15

  The attachment type. The value is WRF, which is used for web form attachments.
• AttachmentTypeXref(optional): string
  Maximum Length: 15

  The cross-reference transaction's attachment type.
• 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 attachment was created.
• Description(optional): string
  Title: Description

  Maximum Length: 100

  The description of the attached file.
• DocumentKey(optional): integer(int64)
  The unique identifier for the attached document.
• FileName(optional): string
  Title: File Name

  Maximum Length: 255

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

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

  The type of the attached file.
• IsAttachmentDeleted(optional): string
  Maximum Length: 255

  Indicates if the cross-reference transaction's attachment is deleted or not.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

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

  Link Relations
• LogMessageId(optional): integer(int64)
  The unique identifier to store the log message ID information. This ID is automatically generated by the application.
• UpdatedByName(optional): string
  Title: Last Updated By

  The user who last updated the attachment.
• Version(optional): integer(int32)
  The unique identifier of the attachment version.
• WebformAttachmentId(optional): integer(int64)
  The attachment ID from the common attachment table.
• WebformId(optional): integer(int64)
  The web form details applied to the file attachment.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the agency associated with the web form attached document.",
            "title":"Agency ID"
        },
        "AttachmentEntityName":{
            "maxLength":255,
            "type":"string",
            "description":"The unique name given to a web form attachment that is used by the attachment component."
        },
        "AttachmentId":{
            "format":"int64",
            "type":"integer",
            "description":"The attachment ID from the common attachment table."
        },
        "AttachmentIdXref":{
            "format":"int64",
            "type":"integer",
            "description":"The cross-reference transaction's attachment identifier."
        },
        "AttachmentType":{
            "maxLength":15,
            "type":"string",
            "description":"The attachment type. The value is WRF, which is used for web form attachments."
        },
        "AttachmentTypeXref":{
            "maxLength":15,
            "type":"string",
            "description":"The cross-reference transaction's 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 attachment was created.",
            "title":"Uploaded On"
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"The description of the attached file.",
            "title":"Description"
        },
        "DocumentKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the attached document."
        },
        "FileName":{
            "maxLength":255,
            "type":"string",
            "description":"The name of the attached file.",
            "title":"File Name"
        },
        "FileSize":{
            "format":"int64",
            "type":"integer",
            "description":"The size of the attached file.",
            "title":"File Size"
        },
        "FileType":{
            "maxLength":100,
            "type":"string",
            "description":"The type of the attached file."
        },
        "IsAttachmentDeleted":{
            "maxLength":255,
            "type":"string",
            "description":"Indicates if the cross-reference transaction's attachment is deleted or not."
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the attachment was last updated.",
            "title":"Last Updated Date"
        },
        "LogMessageId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier to store the log message ID information. This ID is automatically generated by the application."
        },
        "UpdatedByName":{
            "type":"string",
            "description":"The user who last updated the attachment.",
            "title":"Last Updated By"
        },
        "Version":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the attachment version."
        },
        "WebformAttachmentId":{
            "format":"int64",
            "type":"integer",
            "description":"The attachment ID from the common attachment table."
        },
        "WebformId":{
            "format":"int64",
            "type":"integer",
            "description":"The web form details applied to the file attachment."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "required":[
        "AttachmentType"
    ],
    "discriminator":"AttachmentType",
    "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 : publicSectorWebformAttachments-item

Type: object

Discriminator: AttachmentType

Show Source

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

  The unique identifier of the agency associated with the web form attached document.
• AttachmentEntityName(optional): string
  Maximum Length: 255

  The unique name given to a web form attachment that is used by the attachment component.
• AttachmentId(optional): integer(int64)
  The attachment ID from the common attachment table.
• AttachmentIdXref(optional): integer(int64)
  The cross-reference transaction's attachment identifier.
• AttachmentType: string
  Maximum Length: 15

  The attachment type. The value is WRF, which is used for web form attachments.
• AttachmentTypeXref(optional): string
  Maximum Length: 15

  The cross-reference transaction's attachment type.
• 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 attachment was created.
• Description(optional): string
  Title: Description

  Maximum Length: 100

  The description of the attached file.
• DocumentKey(optional): integer(int64)
  The unique identifier for the attached document.
• FileName(optional): string
  Title: File Name

  Maximum Length: 255

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

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

  The type of the attached file.
• IsAttachmentDeleted(optional): string
  Maximum Length: 255

  Indicates if the cross-reference transaction's attachment is deleted or not.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

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

  Link Relations
• LogMessageId(optional): integer(int64)
  The unique identifier to store the log message ID information. This ID is automatically generated by the application.
• UpdatedByName(optional): string
  Title: Last Updated By

  The user who last updated the attachment.
• Version(optional): integer(int32)
  The unique identifier of the attachment version.
• WebformAttachmentId(optional): integer(int64)
  The attachment ID from the common attachment table.
• WebformId(optional): integer(int64)
  The web form details applied to the file attachment.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the agency associated with the web form attached document.",
            "title":"Agency ID"
        },
        "AttachmentEntityName":{
            "maxLength":255,
            "type":"string",
            "description":"The unique name given to a web form attachment that is used by the attachment component."
        },
        "AttachmentId":{
            "format":"int64",
            "type":"integer",
            "description":"The attachment ID from the common attachment table."
        },
        "AttachmentIdXref":{
            "format":"int64",
            "type":"integer",
            "description":"The cross-reference transaction's attachment identifier."
        },
        "AttachmentType":{
            "maxLength":15,
            "type":"string",
            "description":"The attachment type. The value is WRF, which is used for web form attachments."
        },
        "AttachmentTypeXref":{
            "maxLength":15,
            "type":"string",
            "description":"The cross-reference transaction's 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 attachment was created.",
            "title":"Uploaded On"
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"The description of the attached file.",
            "title":"Description"
        },
        "DocumentKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the attached document."
        },
        "FileName":{
            "maxLength":255,
            "type":"string",
            "description":"The name of the attached file.",
            "title":"File Name"
        },
        "FileSize":{
            "format":"int64",
            "type":"integer",
            "description":"The size of the attached file.",
            "title":"File Size"
        },
        "FileType":{
            "maxLength":100,
            "type":"string",
            "description":"The type of the attached file."
        },
        "IsAttachmentDeleted":{
            "maxLength":255,
            "type":"string",
            "description":"Indicates if the cross-reference transaction's attachment is deleted or not."
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the attachment was last updated.",
            "title":"Last Updated Date"
        },
        "LogMessageId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier to store the log message ID information. This ID is automatically generated by the application."
        },
        "UpdatedByName":{
            "type":"string",
            "description":"The user who last updated the attachment.",
            "title":"Last Updated By"
        },
        "Version":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the attachment version."
        },
        "WebformAttachmentId":{
            "format":"int64",
            "type":"integer",
            "description":"The attachment ID from the common attachment table."
        },
        "WebformId":{
            "format":"int64",
            "type":"integer",
            "description":"The web form details applied to the file attachment."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "required":[
        "AttachmentType"
    ],
    "discriminator":"AttachmentType",
    "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