Jump to

• Request
• Response

Create a set of workflow attachments

post

/fscmRestApi/resources/11.13.18.05/publicSectorPcsAttachments/{publicSectorPcsAttachmentsUniqID}/child/PcsAttachmentAccessor

Request

Supported Media Types

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

Path Parameters

• publicSectorPcsAttachmentsUniqID: integer
  This is the hash key of the attributes which make up the composite key--- PcsAttachmentId, LnpRecordKey and TaskId ---for the Workflow Attachments resource and used to uniquely identify an instance of Workflow Attachments. The client should not generate the hash key value. Instead, the client should query on the Workflow Attachments collection resource with a filter on the primary key values in order to navigate to a specific instance of Workflow Attachments.
  
  For example: publicSectorPcsAttachments?q=PcsAttachmentId=<value1>;LnpRecordKey=<value2>;TaskId=<value3>

Body ()

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

Root Schema : publicSectorPcsAttachments-PcsAttachmentAccessor-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 attached document ID that is used by the Attachments framework.
• AttachmentsRevision(optional): array Attachment Revisions
  Title: Attachment Revisions

  The attachments resource is used to perform the file attachment functionality.
• CategoryName(optional): string
  Title: Category

  Maximum Length: 30

  The category name of the attachment that is used by the Attachments framework.
• ContentRepositoryFileShared(optional): boolean
  Title: Shared

  The content repository file shared by the attachment that is used by the Attachments framework.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 255

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

  The name of the user who created the attachment that is used by the Attachments framework.
• CreationDate(optional): string(date-time)
  Title: Creation Date

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

  Maximum Length: 30

  The data type code that is used by the Attachments framework..
• Description(optional): string
  Title: Description

  Maximum Length: 255

  The description of the attachment that is used by the Attachments framework.
• 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 attachment that is used by the Attachments framework.
• 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 status code of the attachment that is used by the Attachments framework.
• ErrorStatusMessage(optional): string
  Title: Error Status Message

  The error status message of the attachment that is used by the Attachments framework.
• ExpirationDate(optional): string(date-time)
  Title: Expiration Date

  The expiration date of the attachment that is used by the Attachments framework.
• FileContents(optional): string(binary)
  Title: File Contents

  The contents of the attachment file that is used by the Attachments framework.
• FileName(optional): string
  Title: File Name

  Maximum Length: 2048

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

  The URL of the attachment file that is used by the Attachments framework.
• LastUpdateDate(optional): string(date-time)
  Title: Last Update Date

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

  Maximum Length: 255

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

  The name of the user who last updated the attachment that is used by the Attachments framework.
• links(optional): array Items
  Title: Items

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

  The title of the attachment that is used by the Attachments framework.
• UploadedFileContentType(optional): string
  Title: Uploaded File Content Type

  The uploaded file content type of the attachment that is used by the Attachments framework.
• UploadedFileLength(optional): integer(int64)
  Title: File Size

  The uploaded length of the attachment file that is used by the Attachments framework.
• UploadedFileName(optional): string
  Title: Uploaded File Name

  The uploaded file name of the attachment that is used by the Attachments framework.
• UploadedText(optional): string
  Title: Uploaded Text

  The uploaded text from the attachment that is used by the Attachments framework.
• Uri(optional): string
  Title: Uri

  Maximum Length: 4000

  The URL of the attachment that is used by the Attachments framework.
• Url(optional): string
  Title: Url

  Maximum Length: 4000

  The URL of the attachment that is used by the Attachments framework.
• UserName(optional): string
  Title: User Name

  Maximum Length: 255

  The user name that is used by the Attachments framework.

{
    "properties":{
        "AsyncTrackerId":{
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "title":"Asynchronous Upload Tracker Id"
        },
        "AttachedDocumentId":{
            "format":"int64",
            "type":"integer",
            "description":"The attached document ID that is used by the Attachments framework.",
            "title":"Attached Document Id"
        },
        "AttachmentsRevision":{
            "items":{
                "$ref":"#/definitions/publicSectorPcsAttachments-PcsAttachmentAccessor-AttachmentsRevision-item"
            },
            "type":"array",
            "description":"The attachments resource is used to perform the file attachment functionality.",
            "title":"Attachment Revisions"
        },
        "CategoryName":{
            "maxLength":30,
            "type":"string",
            "description":"The category name of the attachment that is used by the Attachments framework.",
            "title":"Category"
        },
        "ContentRepositoryFileShared":{
            "type":"boolean",
            "description":"The content repository file shared by the attachment that is used by the Attachments framework.",
            "title":"Shared"
        },
        "CreatedBy":{
            "maxLength":255,
            "type":"string",
            "description":"The name of the user who created the row.",
            "title":"Created By"
        },
        "CreatedByUserName":{
            "type":"string",
            "description":"The name of the user who created the attachment that is used by the Attachments framework.",
            "title":"Created By User Name"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was created.",
            "title":"Creation Date"
        },
        "DatatypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"The data type code that is used by the Attachments framework..",
            "title":"Type"
        },
        "Description":{
            "maxLength":255,
            "type":"string",
            "description":"The description of the attachment that is used by the Attachments framework.",
            "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 of the attachment that is used by the Attachments framework.",
            "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 status code of the attachment that is used by the Attachments framework.",
            "title":"Error Status Code"
        },
        "ErrorStatusMessage":{
            "type":"string",
            "description":"The error status message of the attachment that is used by the Attachments framework.",
            "title":"Error Status Message"
        },
        "ExpirationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The expiration date of the attachment that is used by the Attachments framework.",
            "title":"Expiration Date"
        },
        "FileContents":{
            "format":"binary",
            "type":"string",
            "description":"The contents of the attachment file that is used by the Attachments framework.",
            "title":"File Contents"
        },
        "FileName":{
            "maxLength":2048,
            "type":"string",
            "description":"The file name of the attachment.",
            "title":"File Name"
        },
        "FileUrl":{
            "type":"string",
            "description":"The URL of the attachment file that is used by the Attachments framework.",
            "title":"File Url"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "title":"Last Update Date"
        },
        "LastUpdatedBy":{
            "maxLength":255,
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "title":"Last Updated By"
        },
        "LastUpdatedByUserName":{
            "type":"string",
            "description":"The name of the user who last updated the attachment that is used by the Attachments framework.",
            "title":"Last Updated By User"
        },
        "Title":{
            "type":"string",
            "description":"The title of the attachment that is used by the Attachments framework.",
            "title":"Title"
        },
        "UploadedFileContentType":{
            "type":"string",
            "description":"The uploaded file content type of the attachment that is used by the Attachments framework.",
            "title":"Uploaded File Content Type"
        },
        "UploadedFileLength":{
            "format":"int64",
            "type":"integer",
            "description":"The uploaded length of the attachment file that is used by the Attachments framework.",
            "title":"File Size"
        },
        "UploadedFileName":{
            "type":"string",
            "description":"The uploaded file name of the attachment that is used by the Attachments framework.",
            "title":"Uploaded File Name"
        },
        "UploadedText":{
            "type":"string",
            "description":"The uploaded text from the attachment that is used by the Attachments framework.",
            "title":"Uploaded Text"
        },
        "Uri":{
            "maxLength":4000,
            "type":"string",
            "description":"The URL of the attachment that is used by the Attachments framework.",
            "title":"Uri"
        },
        "Url":{
            "maxLength":4000,
            "type":"string",
            "description":"The URL of the attachment that is used by the Attachments framework.",
            "title":"Url"
        },
        "UserName":{
            "maxLength":255,
            "type":"string",
            "description":"The user name that is used by the Attachments framework.",
            "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 attachments resource is used to perform the file attachment functionality.

Show Source

• Array of: object publicSectorPcsAttachments-PcsAttachmentAccessor-AttachmentsRevision-item

{
    "items":{
        "$ref":"#/definitions/publicSectorPcsAttachments-PcsAttachmentAccessor-AttachmentsRevision-item"
    },
    "type":"array",
    "description":"The attachments resource is used to perform the file attachment functionality.",
    "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 : publicSectorPcsAttachments-PcsAttachmentAccessor-AttachmentsRevision-item

Type: object

Show Source

• AttachedDocumentId(optional): integer(int64)
  The attached document ID of the attachment that is used by the Attachments framework.
• ContentId(optional): string
  Maximum Length: 80

  The content ID of the attachment that is used by the Attachments framework.
• ErrorStatusCode(optional): string
  The error status code of the attachment that is used by the Attachments framework.
• ErrorStatusMessage(optional): string
  The error status message of the attachment that is used by the Attachments framework.
• FileUrl(optional): string
  The URL of the attachment file that is used by the Attachments framework.
• Format(optional): string
  Maximum Length: 128

  The format of the attachment that is used by the Attachments framework.
• InDate(optional): string(date-time)
  The entry date of the attachment that is used by the Attachments framework.
• links(optional): array Items
  Title: Items

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

  The revision ID of the attachment that is used by the Attachments framework.
• RevLabel(optional): string
  Maximum Length: 80

  The revision label of the attachment that is used by the Attachments framework.
• UserRevisionId(optional): integer(int64)
  The user revision ID of the attachment that is used by the Attachments framework.

{
    "properties":{
        "AttachedDocumentId":{
            "format":"int64",
            "type":"integer",
            "description":"The attached document ID of the attachment that is used by the Attachments framework."
        },
        "ContentId":{
            "maxLength":80,
            "type":"string",
            "description":"The content ID of the attachment that is used by the Attachments framework."
        },
        "ErrorStatusCode":{
            "type":"string",
            "description":"The error status code of the attachment that is used by the Attachments framework."
        },
        "ErrorStatusMessage":{
            "type":"string",
            "description":"The error status message of the attachment that is used by the Attachments framework."
        },
        "FileUrl":{
            "type":"string",
            "description":"The URL of the attachment file that is used by the Attachments framework."
        },
        "Format":{
            "maxLength":128,
            "type":"string",
            "description":"The format of the attachment that is used by the Attachments framework."
        },
        "InDate":{
            "format":"date-time",
            "type":"string",
            "description":"The entry date of the attachment that is used by the Attachments framework."
        },
        "RevLabel":{
            "maxLength":80,
            "type":"string",
            "description":"The revision label of the attachment that is used by the Attachments framework."
        },
        "RevisionId":{
            "maxLength":80,
            "type":"string",
            "description":"The revision ID of the attachment that is used by the Attachments framework."
        },
        "UserRevisionId":{
            "format":"int64",
            "type":"integer",
            "description":"The user revision ID of the attachment that is used by the Attachments framework."
        },
        "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 : publicSectorPcsAttachments-PcsAttachmentAccessor-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 attached document ID that is used by the Attachments framework.
• AttachmentsRevision(optional): array Attachment Revisions
  Title: Attachment Revisions

  The attachments resource is used to perform the file attachment functionality.
• CategoryName(optional): string
  Title: Category

  Maximum Length: 30

  The category name of the attachment that is used by the Attachments framework.
• ContentRepositoryFileShared(optional): boolean
  Title: Shared

  The content repository file shared by the attachment that is used by the Attachments framework.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 255

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

  The name of the user who created the attachment that is used by the Attachments framework.
• CreationDate(optional): string(date-time)
  Title: Creation Date

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

  Maximum Length: 30

  The data type code that is used by the Attachments framework..
• Description(optional): string
  Title: Description

  Maximum Length: 255

  The description of the attachment that is used by the Attachments framework.
• 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 attachment that is used by the Attachments framework.
• 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 status code of the attachment that is used by the Attachments framework.
• ErrorStatusMessage(optional): string
  Title: Error Status Message

  The error status message of the attachment that is used by the Attachments framework.
• ExpirationDate(optional): string(date-time)
  Title: Expiration Date

  The expiration date of the attachment that is used by the Attachments framework.
• FileContents(optional): string(binary)
  Title: File Contents

  The contents of the attachment file that is used by the Attachments framework.
• FileName(optional): string
  Title: File Name

  Maximum Length: 2048

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

  The URL of the attachment file that is used by the Attachments framework.
• LastUpdateDate(optional): string(date-time)
  Title: Last Update Date

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

  Maximum Length: 255

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

  The name of the user who last updated the attachment that is used by the Attachments framework.
• links(optional): array Items
  Title: Items

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

  The title of the attachment that is used by the Attachments framework.
• UploadedFileContentType(optional): string
  Title: Uploaded File Content Type

  The uploaded file content type of the attachment that is used by the Attachments framework.
• UploadedFileLength(optional): integer(int64)
  Title: File Size

  The uploaded length of the attachment file that is used by the Attachments framework.
• UploadedFileName(optional): string
  Title: Uploaded File Name

  The uploaded file name of the attachment that is used by the Attachments framework.
• UploadedText(optional): string
  Title: Uploaded Text

  The uploaded text from the attachment that is used by the Attachments framework.
• Uri(optional): string
  Title: Uri

  Maximum Length: 4000

  The URL of the attachment that is used by the Attachments framework.
• Url(optional): string
  Title: Url

  Maximum Length: 4000

  The URL of the attachment that is used by the Attachments framework.
• UserName(optional): string
  Title: User Name

  Maximum Length: 255

  The user name that is used by the Attachments framework.

{
    "properties":{
        "AsyncTrackerId":{
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "title":"Asynchronous Upload Tracker Id"
        },
        "AttachedDocumentId":{
            "format":"int64",
            "type":"integer",
            "description":"The attached document ID that is used by the Attachments framework.",
            "title":"Attached Document Id"
        },
        "AttachmentsRevision":{
            "items":{
                "$ref":"#/definitions/publicSectorPcsAttachments-PcsAttachmentAccessor-AttachmentsRevision-item"
            },
            "type":"array",
            "description":"The attachments resource is used to perform the file attachment functionality.",
            "title":"Attachment Revisions"
        },
        "CategoryName":{
            "maxLength":30,
            "type":"string",
            "description":"The category name of the attachment that is used by the Attachments framework.",
            "title":"Category"
        },
        "ContentRepositoryFileShared":{
            "type":"boolean",
            "description":"The content repository file shared by the attachment that is used by the Attachments framework.",
            "title":"Shared"
        },
        "CreatedBy":{
            "maxLength":255,
            "type":"string",
            "description":"The name of the user who created the row.",
            "title":"Created By"
        },
        "CreatedByUserName":{
            "type":"string",
            "description":"The name of the user who created the attachment that is used by the Attachments framework.",
            "title":"Created By User Name"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was created.",
            "title":"Creation Date"
        },
        "DatatypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"The data type code that is used by the Attachments framework..",
            "title":"Type"
        },
        "Description":{
            "maxLength":255,
            "type":"string",
            "description":"The description of the attachment that is used by the Attachments framework.",
            "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 of the attachment that is used by the Attachments framework.",
            "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 status code of the attachment that is used by the Attachments framework.",
            "title":"Error Status Code"
        },
        "ErrorStatusMessage":{
            "type":"string",
            "description":"The error status message of the attachment that is used by the Attachments framework.",
            "title":"Error Status Message"
        },
        "ExpirationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The expiration date of the attachment that is used by the Attachments framework.",
            "title":"Expiration Date"
        },
        "FileContents":{
            "format":"binary",
            "type":"string",
            "description":"The contents of the attachment file that is used by the Attachments framework.",
            "title":"File Contents"
        },
        "FileName":{
            "maxLength":2048,
            "type":"string",
            "description":"The file name of the attachment.",
            "title":"File Name"
        },
        "FileUrl":{
            "type":"string",
            "description":"The URL of the attachment file that is used by the Attachments framework.",
            "title":"File Url"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "title":"Last Update Date"
        },
        "LastUpdatedBy":{
            "maxLength":255,
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "title":"Last Updated By"
        },
        "LastUpdatedByUserName":{
            "type":"string",
            "description":"The name of the user who last updated the attachment that is used by the Attachments framework.",
            "title":"Last Updated By User"
        },
        "Title":{
            "type":"string",
            "description":"The title of the attachment that is used by the Attachments framework.",
            "title":"Title"
        },
        "UploadedFileContentType":{
            "type":"string",
            "description":"The uploaded file content type of the attachment that is used by the Attachments framework.",
            "title":"Uploaded File Content Type"
        },
        "UploadedFileLength":{
            "format":"int64",
            "type":"integer",
            "description":"The uploaded length of the attachment file that is used by the Attachments framework.",
            "title":"File Size"
        },
        "UploadedFileName":{
            "type":"string",
            "description":"The uploaded file name of the attachment that is used by the Attachments framework.",
            "title":"Uploaded File Name"
        },
        "UploadedText":{
            "type":"string",
            "description":"The uploaded text from the attachment that is used by the Attachments framework.",
            "title":"Uploaded Text"
        },
        "Uri":{
            "maxLength":4000,
            "type":"string",
            "description":"The URL of the attachment that is used by the Attachments framework.",
            "title":"Uri"
        },
        "Url":{
            "maxLength":4000,
            "type":"string",
            "description":"The URL of the attachment that is used by the Attachments framework.",
            "title":"Url"
        },
        "UserName":{
            "maxLength":255,
            "type":"string",
            "description":"The user name that is used by the Attachments framework.",
            "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 attachments resource is used to perform the file attachment functionality.

Show Source

• Array of: object publicSectorPcsAttachments-PcsAttachmentAccessor-AttachmentsRevision-item

{
    "items":{
        "$ref":"#/definitions/publicSectorPcsAttachments-PcsAttachmentAccessor-AttachmentsRevision-item"
    },
    "type":"array",
    "description":"The attachments resource is used to perform the file attachment functionality.",
    "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 : publicSectorPcsAttachments-PcsAttachmentAccessor-AttachmentsRevision-item

Type: object

Show Source

• AttachedDocumentId(optional): integer(int64)
  The attached document ID of the attachment that is used by the Attachments framework.
• ContentId(optional): string
  Maximum Length: 80

  The content ID of the attachment that is used by the Attachments framework.
• ErrorStatusCode(optional): string
  The error status code of the attachment that is used by the Attachments framework.
• ErrorStatusMessage(optional): string
  The error status message of the attachment that is used by the Attachments framework.
• FileUrl(optional): string
  The URL of the attachment file that is used by the Attachments framework.
• Format(optional): string
  Maximum Length: 128

  The format of the attachment that is used by the Attachments framework.
• InDate(optional): string(date-time)
  The entry date of the attachment that is used by the Attachments framework.
• links(optional): array Items
  Title: Items

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

  The revision ID of the attachment that is used by the Attachments framework.
• RevLabel(optional): string
  Maximum Length: 80

  The revision label of the attachment that is used by the Attachments framework.
• UserRevisionId(optional): integer(int64)
  The user revision ID of the attachment that is used by the Attachments framework.

{
    "properties":{
        "AttachedDocumentId":{
            "format":"int64",
            "type":"integer",
            "description":"The attached document ID of the attachment that is used by the Attachments framework."
        },
        "ContentId":{
            "maxLength":80,
            "type":"string",
            "description":"The content ID of the attachment that is used by the Attachments framework."
        },
        "ErrorStatusCode":{
            "type":"string",
            "description":"The error status code of the attachment that is used by the Attachments framework."
        },
        "ErrorStatusMessage":{
            "type":"string",
            "description":"The error status message of the attachment that is used by the Attachments framework."
        },
        "FileUrl":{
            "type":"string",
            "description":"The URL of the attachment file that is used by the Attachments framework."
        },
        "Format":{
            "maxLength":128,
            "type":"string",
            "description":"The format of the attachment that is used by the Attachments framework."
        },
        "InDate":{
            "format":"date-time",
            "type":"string",
            "description":"The entry date of the attachment that is used by the Attachments framework."
        },
        "RevLabel":{
            "maxLength":80,
            "type":"string",
            "description":"The revision label of the attachment that is used by the Attachments framework."
        },
        "RevisionId":{
            "maxLength":80,
            "type":"string",
            "description":"The revision ID of the attachment that is used by the Attachments framework."
        },
        "UserRevisionId":{
            "format":"int64",
            "type":"integer",
            "description":"The user revision ID of the attachment that is used by the Attachments framework."
        },
        "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