Update a revision attachment
patch
/fscmRestApi/resources/11.13.18.05/publicSectorPcsAttachments/{publicSectorPcsAttachmentsUniqID}/child/PcsAttachmentAccessor/{PcsAttachmentAccessorUniqID}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}
Request
Path Parameters
-
AttachmentsRevisionUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Attachment Revisions resource and used to uniquely identify an instance of Attachment Revisions. The client should not generate the hash key value. Instead, the client should query on the Attachment Revisions collection resource in order to navigate to a specific instance of Attachment Revisions to get the hash key.
-
PcsAttachmentAccessorUniqID(required): string
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.
-
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>
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
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.
-
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.
Response
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-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
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.