Get an uploaded attachment

get

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

Request

Path Parameters
  • This is the hash key of the attributes which make up the composite key for the Attachments resource and used to uniquely identify an instance of Attachments. The client should not generate the hash key value. Instead, the client should query on the Attachments collection resource in order to navigate to a specific instance of Attachments to get the hash key.
  • 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
  • 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>
  • 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).
  • 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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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-PcsAttachmentAccessor-item-response
Type: object
Show Source
  • Title: Asynchronous Upload Tracker Id
    Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.
  • Title: Attached Document Id
    The attached document ID that is used by the Attachments framework.
  • Attachment Revisions
    Title: Attachment Revisions
    The attachment revisions resource is used to access all the revision versions of the attachment.
  • Title: Category
    Maximum Length: 30
    The category name of the attachment that is used by the Attachments framework.
  • Title: Shared
    The content repository file shared by the attachment that is used by the Attachments framework.
  • Title: Created By
    Read Only: true
    Maximum Length: 255
    The name of the user who created the row.
  • Title: Created By User Name
    Read Only: true
    The name of the user who created the attachment that is used by the Attachments framework.
  • Title: Creation Date
    Read Only: true
    The date and time when the row was created.
  • Title: Type
    Maximum Length: 30
    Default Value: FILE
    The data type code that is used by the Attachments framework..
  • Title: Description
    Maximum Length: 255
    The description of the attachment that is used by the Attachments framework.
  • Maximum Length: 255
    The document ID from which the attachment is created.
  • Title: Dm Folder Path
    Maximum Length: 1000
    The folder path of the attachment that is used by the Attachments framework.
  • Maximum Length: 255
    The document version number from which the attachment is created.
  • Title: DownloadInfo
    JSON object represented as a string containing information used to programmatically retrieve a file attachment.
  • Title: Error Status Code
    The error status code of the attachment that is used by the Attachments framework.
  • Title: Error Status Message
    The error status message of the attachment that is used by the Attachments framework.
  • Title: Expiration Date
    The expiration date of the attachment that is used by the Attachments framework.
  • Title: File Contents
    The contents of the attachment file that is used by the Attachments framework.
  • Title: File Name
    Maximum Length: 2048
    The file name of the attachment.
  • Title: File Url
    The URL of the attachment file that is used by the Attachments framework.
  • 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.
  • Title: Last Update Date
    Read Only: true
    The date and time when the row was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 255
    The name of the user who last updated the row.
  • 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
  • Title: PostProcessingAction
    The name of the action that can be performed after an attachment is uploaded.
  • Title: Title
    The title of the attachment that is used by the Attachments framework.
  • Title: Uploaded File Content Type
    The uploaded file content type of the attachment that is used by the Attachments framework.
  • Title: File Size
    The uploaded length of the attachment file that is used by the Attachments framework.
  • Title: Uploaded File Name
    The uploaded file name of the attachment that is used by the Attachments framework.
  • Title: Uploaded Text
    The uploaded text from the attachment that is used by the Attachments framework.
  • Title: Uri
    Maximum Length: 4000
    The URL of the attachment that is used by the Attachments framework.
  • Title: Url
    Maximum Length: 4000
    The URL of the attachment that is used by the Attachments framework.
  • Title: User Name
    Read Only: true
    Maximum Length: 255
    The user name that is used by the Attachments framework.
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
Nested Schema : publicSectorPcsAttachments-PcsAttachmentAccessor-AttachmentsRevision-item-response
Type: object
Show Source
Back to Top