Update an attachment to a deliverable
patch
/fscmRestApi/resources/11.13.18.05/deliverables/{DeliverableId}/child/Attachment/{AttachmentUniqID}
Request
Path Parameters
- AttachmentUniqID(required): string This is the hash key of the attributes which make up the composite key for the Attachment to a Deliverable resource and used to uniquely identify an instance of Attachment to a Deliverable. The client should not generate the hash key value. Instead, the client should query on the Attachment to a Deliverable collection resource in order to navigate to a specific instance of Attachment to a Deliverable to get the hash key.
- DeliverableId(required): integer(int64) Identifier of the deliverable. This field is mandatory for PATCH and DELETE operations.
Header Parameters
- Metadata-Context: string 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: string 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- CategoryName: string Title:
CategoryMaximum Length:30Category of the attachment. For POST or PATCH operations, the value must be Project Deliverable. - ContentRepositoryFileShared: boolean
- DatatypeCode: string Title:
TypeMaximum Length:30Default Value:FILEType of attachment. Values are FILE, WEB_PAGE, or TEXT. Default value is TEXT. It is mandatory in POST operations. - Description: string Title:
DescriptionMaximum Length:255Description of the attachment. - DmDocumentId: string Maximum Length:
255The unique identifier of the attachment. - DmFolderPath: string Title:
Dm Folder PathMaximum Length:1000The path to the folder where the uploaded file is stored. - DmVersionNumber: string Maximum Length:
255The version number of the attachment. - DownloadInfo: string Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. - ErrorStatusCode: string Title:
Error Status CodeError code, if the operation returns an error. - ErrorStatusMessage: string Title:
Error Status MessageError message, if the operation returns an error. - ExpirationDate: string (date-time) Title:
Expiration DateExpiration date of the file on the file content server. - FileContents: string (byte) Title:
File ContentsContents of the attachment. This attribute is not being used. - FileName: string Title:
File NameMaximum Length:2048Name of the file if the attachment type is File, or the text itself if the attachment type is File. It is mandatory in POST operations if the attachment type is File or Text. - FileUrl: string Title:
File UrlLocation on the file content server of the attached document or text. This is null if the attachment type is URL. - PostProcessingAction: string Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. - Title: string Title:
TitleTitle of the attachment. - UploadedFileContentType: string Title:
Uploaded File Content TypeType of file uploaded as attachment, such as text, or Excel document. It is mandatory in POST operations if the attachment type is File. - UploadedFileLength: integer Title:
File SizeSize of the file uploaded as attachment. This is null if the attachment type is URL. - UploadedFileName: string Title:
Uploaded File NameName of the attachment file. This attribute is not being used. - UploadedText: string Title:
Uploaded TextText of the attachment. This attribute is not being used. - Uri: string Title:
UriMaximum Length:4000Universal resource identifier, which is a unique identifier of the location on the Internet. - Url: string Title:
UrlMaximum Length:4000Universal Resource Locator, if the attachment type is URL. It is mandatory in POST operations if the attachment type is URL.
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.
Root Schema : deliverables-Attachment-item-response
Type:
Show Source object- AsyncTrackerId: string Title:
Asynchronous Upload Tracker IdAttribute provided for the exclusive use by the Attachment UI components to assist in uploading files. - AttachedDocumentId: integer (int64) Title:
Attached Document IdIdentifier of the attachment. - CategoryName: string Title:
CategoryMaximum Length:30Category of the attachment. For POST or PATCH operations, the value must be Project Deliverable. - ContentRepositoryFileShared: boolean
- CreatedBy: string Title:
Created ByRead Only:trueMaximum Length:255Name of the person who originally created the attachment. In POST or PATCH operation it is automatically populated as the name of the user who creates the attachment. - CreatedByUserName: string Title:
Created By User NameRead Only:trueName of the person who created the record. - CreationDate: string (date-time) Title:
Creation DateRead Only:trueDate when the attachment was originally created. It is automatically populated as the date attachment was created. - DatatypeCode: string Title:
TypeMaximum Length:30Default Value:FILEType of attachment. Values are FILE, WEB_PAGE, or TEXT. Default value is TEXT. It is mandatory in POST operations. - Description: string Title:
DescriptionMaximum Length:255Description of the attachment. - DmDocumentId: string Maximum Length:
255The unique identifier of the attachment. - DmFolderPath: string Title:
Dm Folder PathMaximum Length:1000The path to the folder where the uploaded file is stored. - DmVersionNumber: string Maximum Length:
255The version number of the attachment. - DownloadInfo: string Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. - ErrorStatusCode: string Title:
Error Status CodeError code, if the operation returns an error. - ErrorStatusMessage: string Title:
Error Status MessageError message, if the operation returns an error. - ExpirationDate: string (date-time) Title:
Expiration DateExpiration date of the file on the file content server. - FileContents: string (byte) Title:
File ContentsContents of the attachment. This attribute is not being used. - FileName: string Title:
File NameMaximum Length:2048Name of the file if the attachment type is File, or the text itself if the attachment type is File. It is mandatory in POST operations if the attachment type is File or Text. - FileUrl: string Title:
File UrlLocation on the file content server of the attached document or text. This is null if the attachment type is URL. - FileWebImage: string (byte) Title:
File Web ImageRead Only:trueThe base64 encoded image of the file displayed in .png format if the source is a convertible image. - LastUpdateDate: string (date-time) Title:
Last Update DateRead Only:trueDate when the attachment was last updated. In POST or PATCH operation it is automatically populated as the current date. - LastUpdatedBy: string Title:
Last Updated ByRead Only:trueMaximum Length:255Name of the person who last updated the attachment. In POST or PATCH operation it is automatically populated as the name of the user who updates the attachment. - LastUpdatedByUserName: string Title:
Last Updated By UserRead Only:trueName of the person who last updated the record. - links: array Links Title:
LinksThe link relations associated with the resource instance. - PostProcessingAction: string Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. - Title: string Title:
TitleTitle of the attachment. - UploadedFileContentType: string Title:
Uploaded File Content TypeType of file uploaded as attachment, such as text, or Excel document. It is mandatory in POST operations if the attachment type is File. - UploadedFileLength: integer Title:
File SizeSize of the file uploaded as attachment. This is null if the attachment type is URL. - UploadedFileName: string Title:
Uploaded File NameName of the attachment file. This attribute is not being used. - UploadedText: string Title:
Uploaded TextText of the attachment. This attribute is not being used. - Uri: string Title:
UriMaximum Length:4000Universal resource identifier, which is a unique identifier of the location on the Internet. - Url: string Title:
UrlMaximum Length:4000Universal Resource Locator, if the attachment type is URL. It is mandatory in POST operations if the attachment type is URL. - UserName: string Title:
User NameRead Only:trueMaximum Length:255Category code of the attachment. For POST or PATCH operations, the value must be PROJECT_DELIVERABLE.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source Nested Schema : link
Type:
Show Source object- href: string Title:
hyperlink referenceThe URI to the related resource. - kind: string Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. - name: string Title:
nameThe name of the link to the related resource. - properties: object properties
- rel: string Title:
relationAllowed 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.