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 TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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.
Root Schema : publicSectorPcsAttachments-item-response
Type:
Show Source
object
-
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. -
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.
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to perform the file attachment functionality.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : publicSectorPcsAttachments-PcsAttachmentAccessor-item-response
Type:
Show Source
object
-
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
-
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. -
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.
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorPcsAttachments-PcsAttachmentAccessor-AttachmentsRevision-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- PcsAttachmentAccessor
-
Parameters:
- publicSectorPcsAttachmentsUniqID:
$request.path.publicSectorPcsAttachmentsUniqID
The attachments resource is used to perform the file attachment functionality. - publicSectorPcsAttachmentsUniqID: