Update a supporting document
patch
/fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/SupportingDocuments/{SupportingDocumentsUniqID}
Request
Path Parameters
-
SupportingDocumentsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Supporting Documents resource and used to uniquely identify an instance of Supporting Documents. The client should not generate the hash key value. Instead, the client should query on the Supporting Documents collection resource in order to navigate to a specific instance of Supporting Documents to get the hash key.
-
contractsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Contracts resource and used to uniquely identify an instance of Contracts. The client should not generate the hash key value. Instead, the client should query on the Contracts collection resource in order to navigate to a specific instance of Contracts to get the hash key.
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:30The category name. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEThe data type code. -
Description: string
Title:
DescriptionMaximum Length:255The description of the supporting document. -
DmDocumentId: string
Maximum Length:
255The Dm document ID. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000The Dm folder path. -
DmVersionNumber: string
Maximum Length:
255The Dm version number. -
DownloadInfo: string
Title:
DownloadInfoJSON object, represented as a string, containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeThe error status code. -
ErrorStatusMessage: string
Title:
Error Status MessageThe error status message. -
ExpirationDate: string
(date-time)
Title:
Expiration DateThe expiration date. -
FileContents: string
(byte)
Title:
File ContentsThe file contents. -
FileName: string
Title:
File NameMaximum Length:2048The file name. -
FileUrl: string
Title:
File UrlThe file URL. -
PostProcessingAction: string
Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleThe title of the supporting document. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeThe uploaded file content type. -
UploadedFileLength: integer
Title:
File SizeThe uploaded file length. -
UploadedFileName: string
Title:
Uploaded File NameThe uploaded file name. -
UploadedText: string
Title:
Uploaded TextThe uploaded text. -
Uri: string
Title:
UriMaximum Length:4000The URI. -
Url: string
Title:
UrlMaximum Length:4000The 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 : contracts-SupportingDocuments-item-response
Type:
Show Source
object-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdThe Async Tracker ID. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdThe attached document ID. -
CategoryName: string
Title:
CategoryMaximum Length:30The category name. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255The created by. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueThe created by user name. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe creation date. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEThe data type code. -
Description: string
Title:
DescriptionMaximum Length:255The description of the supporting document. -
DmDocumentId: string
Maximum Length:
255The Dm document ID. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000The Dm folder path. -
DmVersionNumber: string
Maximum Length:
255The Dm version number. -
DownloadInfo: string
Title:
DownloadInfoJSON object, represented as a string, containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeThe error status code. -
ErrorStatusMessage: string
Title:
Error Status MessageThe error status message. -
ExpirationDate: string
(date-time)
Title:
Expiration DateThe expiration date. -
FileContents: string
(byte)
Title:
File ContentsThe file contents. -
FileName: string
Title:
File NameMaximum Length:2048The file name. -
FileUrl: string
Title:
File UrlThe file 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:trueThe last update date of the supporting document. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255The last updated by of the supporting document. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueThe last updated by user name. -
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:
TitleThe title of the supporting document. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeThe uploaded file content type. -
UploadedFileLength: integer
Title:
File SizeThe uploaded file length. -
UploadedFileName: string
Title:
Uploaded File NameThe uploaded file name. -
UploadedText: string
Title:
Uploaded TextThe uploaded text. -
Uri: string
Title:
UriMaximum Length:4000The URI. -
Url: string
Title:
UrlMaximum Length:4000The URL. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255The user name.
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.