Jump to

• Request
• Response

Replace a mapping attachment

patch

/fscmRestApi/resources/11.13.18.05/publicSectorMappingAttachments/{MappingAttachmentKey}

Request

Supported Media Types

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

Path Parameters

• MappingAttachmentKey: integer
  The unique identifier associated with the Data Format Exchange mapping attachment.

Body ()

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

Root Schema : publicSectorMappingAttachments-item

Type: object

Discriminator: AttachmentType

Show Source

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

  The unique identifier of the agency associated with the attachment.
• AttachmentEntityName(optional): string
  The entity name of the attachment resource.
• AttachmentId(optional): integer(int64)
  The attachment ID from the common attachment table.
• AttachmentType: string
  Maximum Length: 15

  The type of the attachment.
• CreatedByName(optional): string
  The name of the user who created the attachment.
• CreationDate(optional): string(date-time)
  The date and time when the attachment was added.
• Description(optional): string
  Title: Description

  Maximum Length: 100

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

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

  The type of file attached, such as PDF or text.
• 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
• MappingAttachmentAccessor(optional): array Mapping Attachment Accessors
  Title: Mapping Attachment Accessors

  The mapping attachment accessors resource is used to store Data Format Exchange mapping attachment file-related information such as file name and file URL.
• MappingAttachmentId(optional): integer(int64)
  The unique identifier of the attachment.
• MappingAttachmentKey(optional): integer(int64)
  The unique identifier associated with the Data Format Exchange mapping attachment.
• MappingName(optional): string
  Maximum Length: 50

  Unique name for the mapping. Mandatory user defined field.
• Preview(optional): string(binary)
  This column contains the thumbnail of an attached file.
• PreviewHeight(optional): number
  This column indicates the height of a stored thumbnail.
• PreviewWidth(optional): number
  This column indicates the width of a stored thumbnail.
• ProcessId(optional): integer(int64)
  The unique identifier of the process associated with the attachment.
• StageStatus(optional): string
  Maximum Length: 1

  The stage status of the attachment.
• TargetSystem(optional): string
  Maximum Length: 20

  The target system the transfer data will be sent to.
• Type(optional): string
  Maximum Length: 1

  The type of mapping associated with the attachment.
• 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 attachment.

{
    "type":"object",
    "properties":{
        "AgencyId":{
            "title":"Agency ID",
            "description":"The unique identifier of the agency associated with the attachment.",
            "type":"integer",
            "format":"int32"
        },
        "AttachmentEntityName":{
            "description":"The entity name of the attachment resource.",
            "type":"string"
        },
        "AttachmentId":{
            "description":"The attachment ID from the common attachment table.",
            "type":"integer",
            "format":"int64"
        },
        "AttachmentType":{
            "description":"The type of the attachment.",
            "type":"string",
            "maxLength":15
        },
        "CreatedByName":{
            "description":"The name of the user who created the attachment.",
            "type":"string"
        },
        "CreationDate":{
            "description":"The date and time when the attachment was added.",
            "type":"string",
            "format":"date-time"
        },
        "Description":{
            "title":"Description",
            "description":"The description of the attachment file.",
            "type":"string",
            "maxLength":100
        },
        "FileName":{
            "description":"The name of the attached file.",
            "type":"string",
            "maxLength":255
        },
        "FileSize":{
            "description":"The size of the attached file.",
            "type":"integer",
            "format":"int64"
        },
        "FileType":{
            "description":"The type of file attached, such as PDF or text.",
            "type":"string",
            "maxLength":100
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "description":"The date and time when the attachment was last updated.",
            "type":"string",
            "format":"date-time"
        },
        "MappingAttachmentAccessor":{
            "title":"Mapping Attachment Accessors",
            "description":"The mapping attachment accessors resource is used to store Data Format Exchange mapping attachment file-related information such as file name and file URL.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/publicSectorMappingAttachments-MappingAttachmentAccessor-item"
            }
        },
        "MappingAttachmentId":{
            "description":"The unique identifier of the attachment.",
            "type":"integer",
            "format":"int64"
        },
        "MappingAttachmentKey":{
            "description":"The unique identifier associated with the Data Format Exchange mapping attachment.",
            "type":"integer",
            "format":"int64"
        },
        "MappingName":{
            "description":"Unique name for the mapping. Mandatory user defined field.",
            "type":"string",
            "maxLength":50
        },
        "Preview":{
            "description":"This column contains the thumbnail of an attached file.",
            "type":"string",
            "format":"binary"
        },
        "PreviewHeight":{
            "description":"This column indicates the height of a stored thumbnail.",
            "type":"number"
        },
        "PreviewWidth":{
            "description":"This column indicates the width of a stored thumbnail.",
            "type":"number"
        },
        "ProcessId":{
            "description":"The unique identifier of the process associated with the attachment.",
            "type":"integer",
            "format":"int64"
        },
        "StageStatus":{
            "description":"The stage status of the attachment.",
            "type":"string",
            "maxLength":1
        },
        "TargetSystem":{
            "description":"The target system the transfer data will be sent to.",
            "type":"string",
            "maxLength":20
        },
        "Type":{
            "description":"The type of mapping associated with the attachment.",
            "type":"string",
            "maxLength":1
        },
        "UpdatedByName":{
            "title":"Last Updated By",
            "description":"The name of the user who last updated the attachment.",
            "type":"string"
        },
        "Version":{
            "description":"The version of the attachment.",
            "type":"integer",
            "format":"int32"
        },
        "links":{
            "title":"Items",
            "description":"Link Relations",
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    },
    "required":[
        "AttachmentType"
    ],
    "discriminator":"AttachmentType"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

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

Nested Schema : Mapping Attachment Accessors

Type: array

Title: Mapping Attachment Accessors

The mapping attachment accessors resource is used to store Data Format Exchange mapping attachment file-related information such as file name and file URL.

Show Source

• Array of: object publicSectorMappingAttachments-MappingAttachmentAccessor-item

{
    "title":"Mapping Attachment Accessors",
    "description":"The mapping attachment accessors resource is used to store Data Format Exchange mapping attachment file-related information such as file name and file URL.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/publicSectorMappingAttachments-MappingAttachmentAccessor-item"
    }
}

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.

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

Nested Schema : publicSectorMappingAttachments-MappingAttachmentAccessor-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 attachment document.
• AttachmentsRevision(optional): array Mapping Attachment Revisions
  Title: Mapping Attachment Revisions

  The mapping attachment revisions resource is used to store Data Format Exchange historical information for mapping attachments.
• CategoryName(optional): string
  Title: Category

  Maximum Length: 30

  The unique name given to the mapping attachment file-related information, which makes the attachment functionality work in conjunction with the entity name.
• ContentRepositoryFileShared(optional): boolean
  Title: Shared

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

  Maximum Length: 255

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

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

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

  Maximum Length: 30

  The datatype code of the attachment.
• 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 of the attached file.
• DmVersionNumber(optional): string
  Maximum Length: 255

  The document version number from which the attachment is created.
• DownloadInfo(optional): string
  Title: DownloadInfo

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

  The code that indicates the error status of the attachment.
• ErrorStatusMessage(optional): string
  Title: Error Status Message

  The message that describes the error status of the attachment.
• ExpirationDate(optional): string(date-time)
  Title: Expiration Date

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

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

  Maximum Length: 2048

  The name of the attached file.
• FileUrl(optional): string
  Title: File Url

  The URL or web address of the attached 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 and time when the attachment was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 255

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

  The user who last updated the attachment.
• 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 such as plain text or comma-separated value format.
• UploadedFileLength(optional): integer(int64)
  Title: File Size

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

  The name of the attached file.
• UploadedText(optional): string
  Title: Uploaded Text

  The text that is entered along with the attachment.
• Uri(optional): string
  Title: Uri

  Maximum Length: 4000

  The type of universal resource identifier (URI) associated with the attachment. For example, URL.
• Url(optional): string
  Title: Url

  Maximum Length: 4000

  The URL associated with an attachment.
• UserName(optional): string
  Title: User Name

  Maximum Length: 255

  The user's unique user name for logging into the system.

{
    "type":"object",
    "properties":{
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "type":"string"
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "description":"The unique identifier of the attachment document.",
            "type":"integer",
            "format":"int64"
        },
        "AttachmentsRevision":{
            "title":"Mapping Attachment Revisions",
            "description":"The mapping attachment revisions resource is used to store Data Format Exchange historical information for mapping attachments.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/publicSectorMappingAttachments-MappingAttachmentAccessor-AttachmentsRevision-item"
            }
        },
        "CategoryName":{
            "title":"Category",
            "description":"The unique name given to the mapping attachment file-related information, which makes the attachment functionality work in conjunction with the entity name.",
            "type":"string",
            "maxLength":30
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "description":"Indicates whether the attached file repository is shared. The default value is false.",
            "type":"boolean"
        },
        "CreatedBy":{
            "title":"Created By",
            "description":"The user who created the attachment.",
            "type":"string",
            "maxLength":255
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "description":"The user who created the attachment.",
            "type":"string"
        },
        "CreationDate":{
            "title":"Creation Date",
            "description":"The date and time when the attachment was created.",
            "type":"string",
            "format":"date-time"
        },
        "DatatypeCode":{
            "title":"Type",
            "description":"The datatype code of the attachment.",
            "type":"string",
            "maxLength":30
        },
        "Description":{
            "title":"Description",
            "description":"The description of the attachment.",
            "type":"string",
            "maxLength":255
        },
        "DmDocumentId":{
            "description":"The document ID from which the attachment is created.",
            "type":"string",
            "maxLength":255
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "description":"The folder path of the attached file.",
            "type":"string",
            "maxLength":1000
        },
        "DmVersionNumber":{
            "description":"The document version number from which the attachment is created.",
            "type":"string",
            "maxLength":255
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "type":"string"
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "description":"The code that indicates the error status of the attachment.",
            "type":"string"
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "description":"The message that describes the error status of the attachment.",
            "type":"string"
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "description":"The date of expiration of the attachment.",
            "type":"string",
            "format":"date-time"
        },
        "FileContents":{
            "title":"File Contents",
            "description":"The file contents of the attachment.",
            "type":"string",
            "format":"binary"
        },
        "FileName":{
            "title":"File Name",
            "description":"The name of the attached file.",
            "type":"string",
            "maxLength":2048
        },
        "FileUrl":{
            "title":"File Url",
            "description":"The URL or web address of the attached file.",
            "type":"string"
        },
        "FileWebImage":{
            "title":"File Web Image",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "type":"string",
            "format":"binary"
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "description":"The date and time when the attachment was last updated.",
            "type":"string",
            "format":"date-time"
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "description":"The user who last updated the attachment.",
            "type":"string",
            "maxLength":255
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "description":"The user who last updated the attachment.",
            "type":"string"
        },
        "Title":{
            "title":"Title",
            "description":"The title of the attachment.",
            "type":"string"
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "description":"The content type of the attachment such as plain text or comma-separated value format.",
            "type":"string"
        },
        "UploadedFileLength":{
            "title":"File Size",
            "description":"The file length of the attachment in bytes.",
            "type":"integer",
            "format":"int64"
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "description":"The name of the attached file.",
            "type":"string"
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "description":"The text that is entered along with the attachment.",
            "type":"string"
        },
        "Uri":{
            "title":"Uri",
            "description":"The type of universal resource identifier (URI) associated with the attachment. For example, URL.",
            "type":"string",
            "maxLength":4000
        },
        "Url":{
            "title":"Url",
            "description":"The URL associated with an attachment.",
            "type":"string",
            "maxLength":4000
        },
        "UserName":{
            "title":"User Name",
            "description":"The user's unique user name for logging into the system.",
            "type":"string",
            "maxLength":255
        },
        "links":{
            "title":"Items",
            "description":"Link Relations",
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    }
}

Nested Schema : Mapping Attachment Revisions

Type: array

Title: Mapping Attachment Revisions

The mapping attachment revisions resource is used to store Data Format Exchange historical information for mapping attachments.

Show Source

• Array of: object publicSectorMappingAttachments-MappingAttachmentAccessor-AttachmentsRevision-item

{
    "title":"Mapping Attachment Revisions",
    "description":"The mapping attachment revisions resource is used to store Data Format Exchange historical information for mapping attachments.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/publicSectorMappingAttachments-MappingAttachmentAccessor-AttachmentsRevision-item"
    }
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

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

Nested Schema : publicSectorMappingAttachments-MappingAttachmentAccessor-AttachmentsRevision-item

Type: object

Show Source

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

  The unique identifier of the attachment content.
• ErrorStatusCode(optional): string
  The code that indicates the error status of the attachment.
• ErrorStatusMessage(optional): string
  The message that describes the error status of the attachment.
• FileUrl(optional): string
  The web address for an attached file.
• Format(optional): string
  Maximum Length: 128

  The format of the attachment.
• InDate(optional): string(date-time)
  Indicates the date when the file was attached.
• links(optional): array Items
  Title: Items

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

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

  The label for an attachment revision.
• UserRevisionId(optional): integer(int64)
  The unique identifier for an attachment revision.

{
    "type":"object",
    "properties":{
        "AttachedDocumentId":{
            "description":"The unique identifier of an attached document.",
            "type":"integer",
            "format":"int64"
        },
        "ContentId":{
            "description":"The unique identifier of the attachment content.",
            "type":"string",
            "maxLength":80
        },
        "ErrorStatusCode":{
            "description":"The code that indicates the error status of the attachment.",
            "type":"string"
        },
        "ErrorStatusMessage":{
            "description":"The message that describes the error status of the attachment.",
            "type":"string"
        },
        "FileUrl":{
            "description":"The web address for an attached file.",
            "type":"string"
        },
        "Format":{
            "description":"The format of the attachment.",
            "type":"string",
            "maxLength":128
        },
        "InDate":{
            "description":"Indicates the date when the file was attached.",
            "type":"string",
            "format":"date-time"
        },
        "RevLabel":{
            "description":"The label for an attachment revision.",
            "type":"string",
            "maxLength":80
        },
        "RevisionId":{
            "description":"The unique identifier of the attachment revision.",
            "type":"string",
            "maxLength":80
        },
        "UserRevisionId":{
            "description":"The unique identifier for an attachment revision.",
            "type":"integer",
            "format":"int64"
        },
        "links":{
            "title":"Items",
            "description":"Link Relations",
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

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

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 : publicSectorMappingAttachments-item

Type: object

Discriminator: AttachmentType

Show Source

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

  The unique identifier of the agency associated with the attachment.
• AttachmentEntityName(optional): string
  The entity name of the attachment resource.
• AttachmentId(optional): integer(int64)
  The attachment ID from the common attachment table.
• AttachmentType: string
  Maximum Length: 15

  The type of the attachment.
• CreatedByName(optional): string
  The name of the user who created the attachment.
• CreationDate(optional): string(date-time)
  The date and time when the attachment was added.
• Description(optional): string
  Title: Description

  Maximum Length: 100

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

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

  The type of file attached, such as PDF or text.
• 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
• MappingAttachmentAccessor(optional): array Mapping Attachment Accessors
  Title: Mapping Attachment Accessors

  The mapping attachment accessors resource is used to store Data Format Exchange mapping attachment file-related information such as file name and file URL.
• MappingAttachmentId(optional): integer(int64)
  The unique identifier of the attachment.
• MappingAttachmentKey(optional): integer(int64)
  The unique identifier associated with the Data Format Exchange mapping attachment.
• MappingName(optional): string
  Maximum Length: 50

  Unique name for the mapping. Mandatory user defined field.
• Preview(optional): string(binary)
  This column contains the thumbnail of an attached file.
• PreviewHeight(optional): number
  This column indicates the height of a stored thumbnail.
• PreviewWidth(optional): number
  This column indicates the width of a stored thumbnail.
• ProcessId(optional): integer(int64)
  The unique identifier of the process associated with the attachment.
• StageStatus(optional): string
  Maximum Length: 1

  The stage status of the attachment.
• TargetSystem(optional): string
  Maximum Length: 20

  The target system the transfer data will be sent to.
• Type(optional): string
  Maximum Length: 1

  The type of mapping associated with the attachment.
• 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 attachment.

{
    "type":"object",
    "properties":{
        "AgencyId":{
            "title":"Agency ID",
            "description":"The unique identifier of the agency associated with the attachment.",
            "type":"integer",
            "format":"int32"
        },
        "AttachmentEntityName":{
            "description":"The entity name of the attachment resource.",
            "type":"string"
        },
        "AttachmentId":{
            "description":"The attachment ID from the common attachment table.",
            "type":"integer",
            "format":"int64"
        },
        "AttachmentType":{
            "description":"The type of the attachment.",
            "type":"string",
            "maxLength":15
        },
        "CreatedByName":{
            "description":"The name of the user who created the attachment.",
            "type":"string"
        },
        "CreationDate":{
            "description":"The date and time when the attachment was added.",
            "type":"string",
            "format":"date-time"
        },
        "Description":{
            "title":"Description",
            "description":"The description of the attachment file.",
            "type":"string",
            "maxLength":100
        },
        "FileName":{
            "description":"The name of the attached file.",
            "type":"string",
            "maxLength":255
        },
        "FileSize":{
            "description":"The size of the attached file.",
            "type":"integer",
            "format":"int64"
        },
        "FileType":{
            "description":"The type of file attached, such as PDF or text.",
            "type":"string",
            "maxLength":100
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "description":"The date and time when the attachment was last updated.",
            "type":"string",
            "format":"date-time"
        },
        "MappingAttachmentAccessor":{
            "title":"Mapping Attachment Accessors",
            "description":"The mapping attachment accessors resource is used to store Data Format Exchange mapping attachment file-related information such as file name and file URL.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/publicSectorMappingAttachments-MappingAttachmentAccessor-item"
            }
        },
        "MappingAttachmentId":{
            "description":"The unique identifier of the attachment.",
            "type":"integer",
            "format":"int64"
        },
        "MappingAttachmentKey":{
            "description":"The unique identifier associated with the Data Format Exchange mapping attachment.",
            "type":"integer",
            "format":"int64"
        },
        "MappingName":{
            "description":"Unique name for the mapping. Mandatory user defined field.",
            "type":"string",
            "maxLength":50
        },
        "Preview":{
            "description":"This column contains the thumbnail of an attached file.",
            "type":"string",
            "format":"binary"
        },
        "PreviewHeight":{
            "description":"This column indicates the height of a stored thumbnail.",
            "type":"number"
        },
        "PreviewWidth":{
            "description":"This column indicates the width of a stored thumbnail.",
            "type":"number"
        },
        "ProcessId":{
            "description":"The unique identifier of the process associated with the attachment.",
            "type":"integer",
            "format":"int64"
        },
        "StageStatus":{
            "description":"The stage status of the attachment.",
            "type":"string",
            "maxLength":1
        },
        "TargetSystem":{
            "description":"The target system the transfer data will be sent to.",
            "type":"string",
            "maxLength":20
        },
        "Type":{
            "description":"The type of mapping associated with the attachment.",
            "type":"string",
            "maxLength":1
        },
        "UpdatedByName":{
            "title":"Last Updated By",
            "description":"The name of the user who last updated the attachment.",
            "type":"string"
        },
        "Version":{
            "description":"The version of the attachment.",
            "type":"integer",
            "format":"int32"
        },
        "links":{
            "title":"Items",
            "description":"Link Relations",
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    },
    "required":[
        "AttachmentType"
    ],
    "discriminator":"AttachmentType"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

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

Nested Schema : Mapping Attachment Accessors

Type: array

Title: Mapping Attachment Accessors

The mapping attachment accessors resource is used to store Data Format Exchange mapping attachment file-related information such as file name and file URL.

Show Source

• Array of: object publicSectorMappingAttachments-MappingAttachmentAccessor-item

{
    "title":"Mapping Attachment Accessors",
    "description":"The mapping attachment accessors resource is used to store Data Format Exchange mapping attachment file-related information such as file name and file URL.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/publicSectorMappingAttachments-MappingAttachmentAccessor-item"
    }
}

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.

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

Nested Schema : publicSectorMappingAttachments-MappingAttachmentAccessor-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 attachment document.
• AttachmentsRevision(optional): array Mapping Attachment Revisions
  Title: Mapping Attachment Revisions

  The mapping attachment revisions resource is used to store Data Format Exchange historical information for mapping attachments.
• CategoryName(optional): string
  Title: Category

  Maximum Length: 30

  The unique name given to the mapping attachment file-related information, which makes the attachment functionality work in conjunction with the entity name.
• ContentRepositoryFileShared(optional): boolean
  Title: Shared

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

  Maximum Length: 255

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

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

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

  Maximum Length: 30

  The datatype code of the attachment.
• 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 of the attached file.
• DmVersionNumber(optional): string
  Maximum Length: 255

  The document version number from which the attachment is created.
• DownloadInfo(optional): string
  Title: DownloadInfo

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

  The code that indicates the error status of the attachment.
• ErrorStatusMessage(optional): string
  Title: Error Status Message

  The message that describes the error status of the attachment.
• ExpirationDate(optional): string(date-time)
  Title: Expiration Date

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

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

  Maximum Length: 2048

  The name of the attached file.
• FileUrl(optional): string
  Title: File Url

  The URL or web address of the attached 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 and time when the attachment was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 255

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

  The user who last updated the attachment.
• 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 such as plain text or comma-separated value format.
• UploadedFileLength(optional): integer(int64)
  Title: File Size

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

  The name of the attached file.
• UploadedText(optional): string
  Title: Uploaded Text

  The text that is entered along with the attachment.
• Uri(optional): string
  Title: Uri

  Maximum Length: 4000

  The type of universal resource identifier (URI) associated with the attachment. For example, URL.
• Url(optional): string
  Title: Url

  Maximum Length: 4000

  The URL associated with an attachment.
• UserName(optional): string
  Title: User Name

  Maximum Length: 255

  The user's unique user name for logging into the system.

{
    "type":"object",
    "properties":{
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "type":"string"
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "description":"The unique identifier of the attachment document.",
            "type":"integer",
            "format":"int64"
        },
        "AttachmentsRevision":{
            "title":"Mapping Attachment Revisions",
            "description":"The mapping attachment revisions resource is used to store Data Format Exchange historical information for mapping attachments.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/publicSectorMappingAttachments-MappingAttachmentAccessor-AttachmentsRevision-item"
            }
        },
        "CategoryName":{
            "title":"Category",
            "description":"The unique name given to the mapping attachment file-related information, which makes the attachment functionality work in conjunction with the entity name.",
            "type":"string",
            "maxLength":30
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "description":"Indicates whether the attached file repository is shared. The default value is false.",
            "type":"boolean"
        },
        "CreatedBy":{
            "title":"Created By",
            "description":"The user who created the attachment.",
            "type":"string",
            "maxLength":255
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "description":"The user who created the attachment.",
            "type":"string"
        },
        "CreationDate":{
            "title":"Creation Date",
            "description":"The date and time when the attachment was created.",
            "type":"string",
            "format":"date-time"
        },
        "DatatypeCode":{
            "title":"Type",
            "description":"The datatype code of the attachment.",
            "type":"string",
            "maxLength":30
        },
        "Description":{
            "title":"Description",
            "description":"The description of the attachment.",
            "type":"string",
            "maxLength":255
        },
        "DmDocumentId":{
            "description":"The document ID from which the attachment is created.",
            "type":"string",
            "maxLength":255
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "description":"The folder path of the attached file.",
            "type":"string",
            "maxLength":1000
        },
        "DmVersionNumber":{
            "description":"The document version number from which the attachment is created.",
            "type":"string",
            "maxLength":255
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "type":"string"
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "description":"The code that indicates the error status of the attachment.",
            "type":"string"
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "description":"The message that describes the error status of the attachment.",
            "type":"string"
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "description":"The date of expiration of the attachment.",
            "type":"string",
            "format":"date-time"
        },
        "FileContents":{
            "title":"File Contents",
            "description":"The file contents of the attachment.",
            "type":"string",
            "format":"binary"
        },
        "FileName":{
            "title":"File Name",
            "description":"The name of the attached file.",
            "type":"string",
            "maxLength":2048
        },
        "FileUrl":{
            "title":"File Url",
            "description":"The URL or web address of the attached file.",
            "type":"string"
        },
        "FileWebImage":{
            "title":"File Web Image",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "type":"string",
            "format":"binary"
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "description":"The date and time when the attachment was last updated.",
            "type":"string",
            "format":"date-time"
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "description":"The user who last updated the attachment.",
            "type":"string",
            "maxLength":255
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "description":"The user who last updated the attachment.",
            "type":"string"
        },
        "Title":{
            "title":"Title",
            "description":"The title of the attachment.",
            "type":"string"
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "description":"The content type of the attachment such as plain text or comma-separated value format.",
            "type":"string"
        },
        "UploadedFileLength":{
            "title":"File Size",
            "description":"The file length of the attachment in bytes.",
            "type":"integer",
            "format":"int64"
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "description":"The name of the attached file.",
            "type":"string"
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "description":"The text that is entered along with the attachment.",
            "type":"string"
        },
        "Uri":{
            "title":"Uri",
            "description":"The type of universal resource identifier (URI) associated with the attachment. For example, URL.",
            "type":"string",
            "maxLength":4000
        },
        "Url":{
            "title":"Url",
            "description":"The URL associated with an attachment.",
            "type":"string",
            "maxLength":4000
        },
        "UserName":{
            "title":"User Name",
            "description":"The user's unique user name for logging into the system.",
            "type":"string",
            "maxLength":255
        },
        "links":{
            "title":"Items",
            "description":"Link Relations",
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    }
}

Nested Schema : Mapping Attachment Revisions

Type: array

Title: Mapping Attachment Revisions

The mapping attachment revisions resource is used to store Data Format Exchange historical information for mapping attachments.

Show Source

• Array of: object publicSectorMappingAttachments-MappingAttachmentAccessor-AttachmentsRevision-item

{
    "title":"Mapping Attachment Revisions",
    "description":"The mapping attachment revisions resource is used to store Data Format Exchange historical information for mapping attachments.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/publicSectorMappingAttachments-MappingAttachmentAccessor-AttachmentsRevision-item"
    }
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

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

Nested Schema : publicSectorMappingAttachments-MappingAttachmentAccessor-AttachmentsRevision-item

Type: object

Show Source

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

  The unique identifier of the attachment content.
• ErrorStatusCode(optional): string
  The code that indicates the error status of the attachment.
• ErrorStatusMessage(optional): string
  The message that describes the error status of the attachment.
• FileUrl(optional): string
  The web address for an attached file.
• Format(optional): string
  Maximum Length: 128

  The format of the attachment.
• InDate(optional): string(date-time)
  Indicates the date when the file was attached.
• links(optional): array Items
  Title: Items

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

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

  The label for an attachment revision.
• UserRevisionId(optional): integer(int64)
  The unique identifier for an attachment revision.

{
    "type":"object",
    "properties":{
        "AttachedDocumentId":{
            "description":"The unique identifier of an attached document.",
            "type":"integer",
            "format":"int64"
        },
        "ContentId":{
            "description":"The unique identifier of the attachment content.",
            "type":"string",
            "maxLength":80
        },
        "ErrorStatusCode":{
            "description":"The code that indicates the error status of the attachment.",
            "type":"string"
        },
        "ErrorStatusMessage":{
            "description":"The message that describes the error status of the attachment.",
            "type":"string"
        },
        "FileUrl":{
            "description":"The web address for an attached file.",
            "type":"string"
        },
        "Format":{
            "description":"The format of the attachment.",
            "type":"string",
            "maxLength":128
        },
        "InDate":{
            "description":"Indicates the date when the file was attached.",
            "type":"string",
            "format":"date-time"
        },
        "RevLabel":{
            "description":"The label for an attachment revision.",
            "type":"string",
            "maxLength":80
        },
        "RevisionId":{
            "description":"The unique identifier of the attachment revision.",
            "type":"string",
            "maxLength":80
        },
        "UserRevisionId":{
            "description":"The unique identifier for an attachment revision.",
            "type":"integer",
            "format":"int64"
        },
        "links":{
            "title":"Items",
            "description":"Link Relations",
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

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

Back to Top