Jump to

• Request
• Response

Get a workflow attachment

get

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

Request

Path Parameters

• publicSectorPcsAttachmentsUniqID(required): string
  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>

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : publicSectorPcsAttachments-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  The unique identifier of the agency.
• AttachmentEntityName: string
  Default Value: PSC_DOC_PCS

  The entity name that is used by the Attachments framework.
• AttachmentId: integer (int64)
  The unique identifier of the attachment.
• AttachmentType: string
  Maximum Length: 15

  Default Value: PCS

  The file type of the attachment.
• ConfidentialFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates whether the attachment is a confidential document. The default value is N for no.
• CreatedByName: string
  Title: Uploaded By

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

  Read Only: true

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

  Maximum Length: 100

  The description about the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 255

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

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

  The column that is used to indicate the file type.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the row was last updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LnpRecordKey: integer (int64)
  The unique identifier of the record that is associated with attachment.
• PcsAttachmentAccessor: array Attachments
  Title: Attachments

  The attachments resource is used to perform the file attachment functionality.
• PcsAttachmentId: integer (int64)
  The unique identifier of the attachment.
• Preview: string (byte)
  This column contains the thumbnail of an attached file.
• PreviewHeight: number
  This column indicates the height of a stored thumbnail.
• PreviewWidth: number
  This column indicates the width of a stored thumbnail.
• RequiredFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates whether the attachment is a required document. The default value is N for no.
• TaskId: string
  Maximum Length: 100

  The unique identifier of the workflow task that is associated with the attachment.
• TaskStatus: string
  Maximum Length: 50

  The status of the workflow task that is associated with the attachment.
• UpdatedByName: string
  Title: Last Updated By

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

{
    "type":"object",
    "properties":{
        "CreatedByName":{
            "title":"Uploaded By",
            "type":"string",
            "description":"The name of the user who created the attachment.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Uploaded On",
            "type":"string",
            "description":"The date and time when the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ConfidentialFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the attachment is a confidential document. The default value is N for no.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "PreviewWidth":{
            "type":"number",
            "description":"This column indicates the width of a stored thumbnail.",
            "nullable":true,
            "x-hints":{
                "precision":"8",
                "scale":"2"
            },
            "x-queryable":true
        },
        "PreviewHeight":{
            "type":"number",
            "description":"This column indicates the height of a stored thumbnail.",
            "nullable":true,
            "x-hints":{
                "precision":"8",
                "scale":"2"
            },
            "x-queryable":true
        },
        "AttachmentType":{
            "maxLength":"15",
            "type":"string",
            "description":"The file type of the attachment.",
            "nullable":true,
            "default":"PCS",
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"100",
            "type":"string",
            "description":"The description about the attachment.",
            "nullable":true,
            "x-queryable":true
        },
        "TaskId":{
            "maxLength":"100",
            "type":"string",
            "description":"The unique identifier of the workflow task that is associated with the attachment.",
            "nullable":false,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier of the agency.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "UpdatedByName":{
            "title":"Last Updated By",
            "type":"string",
            "description":"The name of the user who last updated the attachment.",
            "nullable":true,
            "x-queryable":true
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"255",
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":false,
            "x-queryable":true
        },
        "Preview":{
            "type":"string",
            "description":"This column contains the thumbnail of an attached file.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "TaskStatus":{
            "maxLength":"50",
            "type":"string",
            "description":"The status of the workflow task that is associated with the attachment.",
            "nullable":true,
            "x-queryable":true
        },
        "LnpRecordKey":{
            "type":"integer",
            "description":"The unique identifier of the record that is associated with attachment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AttachmentId":{
            "type":"integer",
            "description":"The unique identifier of the attachment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PcsAttachmentAccessor":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to perform the file attachment functionality.",
            "items":{
                "$ref":"#/components/schemas/publicSectorPcsAttachments-PcsAttachmentAccessor-item-response"
            }
        },
        "FileType":{
            "maxLength":"100",
            "type":"string",
            "description":"The column that is used to indicate the file type.",
            "nullable":true,
            "x-queryable":true
        },
        "Version":{
            "type":"integer",
            "description":"The version of the file.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"4"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RequiredFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the attachment is a required document. The default value is N for no.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "PcsAttachmentId":{
            "type":"integer",
            "description":"The unique identifier of the attachment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AttachmentEntityName":{
            "type":"string",
            "description":"The entity name that is used by the Attachments framework.",
            "nullable":true,
            "default":"PSC_DOC_PCS",
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FileSize":{
            "title":"File Size",
            "type":"integer",
            "description":"The file size of the attachment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The attachments resource is used to perform the file attachment functionality.

Show Source

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

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to perform the file attachment functionality.",
    "items":{
        "$ref":"#/components/schemas/publicSectorPcsAttachments-PcsAttachmentAccessor-item-response"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

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

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : publicSectorPcsAttachments-PcsAttachmentAccessor-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

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

  The attached document ID that is used by the Attachments framework.
• AttachmentsRevision: array Attachment Revisions
  Title: Attachment Revisions

  The attachment revisions resource is used to access all the revision versions of the attachment.
• CategoryName: string
  Title: Category

  Maximum Length: 30

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

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

  Read Only: true

  Maximum Length: 255

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

  Read Only: true

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

  Read Only: true

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

  Maximum Length: 30

  Default Value: FILE

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

  Maximum Length: 255

  The description of the attachment that is used by the Attachments framework.
• DmDocumentId: string
  Maximum Length: 255

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

  Maximum Length: 1000

  The folder path of the attachment that is used by the Attachments framework.
• DmVersionNumber: string
  Maximum Length: 255

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

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

  The error status code of the attachment that is used by the Attachments framework.
• ErrorStatusMessage: string
  Title: Error Status Message

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

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

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

  Maximum Length: 2048

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

  The URL of the attachment file that is used by the Attachments framework.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

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

  Read Only: true

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

  Read Only: true

  Maximum Length: 255

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

  Read Only: true

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

  The link relations associated with the resource instance.
• PostProcessingAction: string
  Title: PostProcessingAction

  The name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

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

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

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

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

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

  Maximum Length: 4000

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

  Maximum Length: 4000

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

  Read Only: true

  Maximum Length: 255

  The user name that is used by the Attachments framework.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"255",
            "type":"string",
            "description":"The description of the attachment that is used by the Attachments framework.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"2048",
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "AttachmentsRevision":{
            "title":"Attachment Revisions",
            "type":"array",
            "description":"The attachment revisions resource is used to access all the revision versions of the attachment.",
            "items":{
                "$ref":"#/components/schemas/publicSectorPcsAttachments-PcsAttachmentAccessor-AttachmentsRevision-item-response"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":"4000",
            "type":"string",
            "description":"The URL of the attachment that is used by the Attachments framework.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":"4000",
            "type":"string",
            "description":"The URL of the attachment that is used by the Attachments framework.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The attached document ID that is used by the Attachments framework.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The uploaded file content type of the attachment that is used by the Attachments framework.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"The name of the user who created the attachment that is used by the Attachments framework.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The uploaded length of the attachment file that is used by the Attachments framework.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"255",
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error status message of the attachment that is used by the Attachments framework.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UserName":{
            "title":"User Name",
            "maxLength":"255",
            "type":"string",
            "description":"The user name that is used by the Attachments framework.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"255",
            "type":"string",
            "description":"The name of the user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"The data type code that is used by the Attachments framework..",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment that is used by the Attachments framework.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"The name of the user who last updated the attachment that is used by the Attachments framework.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The uploaded file name of the attachment that is used by the Attachments framework.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URL of the attachment file that is used by the Attachments framework.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"The content repository file shared by the attachment that is used by the Attachments framework.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment file that is used by the Attachments framework.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the attachment that is used by the Attachments framework.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error status code of the attachment that is used by the Attachments framework.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":"1000",
            "type":"string",
            "description":"The folder path of the attachment that is used by the Attachments framework.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The uploaded text from the attachment that is used by the Attachments framework.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"The category name of the attachment that is used by the Attachments framework.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

Nested Schema : Attachment Revisions

Type: array

Title: Attachment Revisions

The attachment revisions resource is used to access all the revision versions of the attachment.

Show Source

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

{
    "title":"Attachment Revisions",
    "type":"array",
    "description":"The attachment revisions resource is used to access all the revision versions of the attachment.",
    "items":{
        "$ref":"#/components/schemas/publicSectorPcsAttachments-PcsAttachmentAccessor-AttachmentsRevision-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : publicSectorPcsAttachments-PcsAttachmentAccessor-AttachmentsRevision-item-response

Type: object

Show Source

• AttachedDocumentId: string
  Read Only: true

  The attached document ID of the attachment that is used by the Attachments framework.
• ContentId: string
  Maximum Length: 80

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

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

  The link relations associated with the resource instance.
• RevisionId: string
  Maximum Length: 80

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

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

{
    "type":"object",
    "properties":{
        "FileUrl":{
            "type":"string",
            "description":"The URL of the attachment file that is used by the Attachments framework.",
            "nullable":true,
            "x-queryable":false
        },
        "ErrorStatusMessage":{
            "type":"string",
            "description":"The error status message of the attachment that is used by the Attachments framework.",
            "nullable":true,
            "x-queryable":false
        },
        "AttachedDocumentId":{
            "type":"string",
            "description":"The attached document ID of the attachment that is used by the Attachments framework.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "InDate":{
            "type":"string",
            "description":"The entry date of the attachment that is used by the Attachments framework.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "Format":{
            "maxLength":"128",
            "type":"string",
            "description":"The format of the attachment that is used by the Attachments framework.",
            "nullable":true,
            "x-queryable":true
        },
        "UserRevisionId":{
            "type":"integer",
            "description":"The user revision ID of the attachment that is used by the Attachments framework.",
            "nullable":true,
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "type":"string",
            "description":"The error status code of the attachment that is used by the Attachments framework.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ContentId":{
            "maxLength":"80",
            "type":"string",
            "description":"The content ID of the attachment that is used by the Attachments framework.",
            "nullable":false,
            "x-queryable":true
        },
        "RevisionId":{
            "maxLength":"80",
            "type":"string",
            "description":"The revision ID of the attachment that is used by the Attachments framework.",
            "nullable":false,
            "x-queryable":true
        },
        "RevLabel":{
            "maxLength":"80",
            "type":"string",
            "description":"The revision label of the attachment that is used by the Attachments framework.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

PcsAttachmentAccessor

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

Parameters:

• publicSectorPcsAttachmentsUniqID: $request.path.publicSectorPcsAttachmentsUniqID

The attachments resource is used to perform the file attachment functionality.

Back to Top