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:
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
-
CategoryName: string
Title:
Category
Maximum Length:30
The code for the category to which the internal shared document is assigned. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
The code that identifies if the external shared document is a file or a URL. -
Description: string
Title:
Description
Maximum Length:255
The description of the internal shared document. -
DmDocumentId: string
Maximum Length:
255
The Dm document id of the internal shared document. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The Dm folder path of the internal shared document. -
DmVersionNumber: string
Maximum Length:
255
The Dm version number of the internal shared document. -
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 for the internal shared document. -
ErrorStatusMessage: string
Title:
Error Status Message
The error status message for the internal shared document. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The expiration date of the internal shared document. -
FileContents: string
(byte)
Title:
File Contents
The file contents of the internal shared document. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the internal shared document. A file name or URL is required. -
FileUrl: string
Title:
File Url
The URL location of the internal shared document. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
The title of the internal shared document. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The uploaded file content type of the internal shared document. -
UploadedFileLength: integer
Title:
File Size
The uploaded file length of the internal shared document. -
UploadedFileName: string
Title:
Uploaded File Name
The uploaded file name of the internal shared document. -
UploadedText: string
Title:
Uploaded Text
The uploaded text of the internal shared document. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of the internal shared document. -
Url: string
Title:
Url
Maximum Length:4000
The URL of the internal shared document. A file name or URL is required.
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 Id
The async tracker ID of the internal shared document. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attached internal shared document. -
CategoryName: string
Title:
Category
Maximum Length:30
The code for the category to which the internal shared document is assigned. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the internal shared document. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
The name of the user who created the internal shared document. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the internal shared document was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
The code that identifies if the external shared document is a file or a URL. -
Description: string
Title:
Description
Maximum Length:255
The description of the internal shared document. -
DmDocumentId: string
Maximum Length:
255
The Dm document id of the internal shared document. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The Dm folder path of the internal shared document. -
DmVersionNumber: string
Maximum Length:
255
The Dm version number of the internal shared document. -
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 for the internal shared document. -
ErrorStatusMessage: string
Title:
Error Status Message
The error status message for the internal shared document. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The expiration date of the internal shared document. -
FileContents: string
(byte)
Title:
File Contents
The file contents of the internal shared document. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the internal shared document. A file name or URL is required. -
FileUrl: string
Title:
File Url
The URL location of the internal shared document. -
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 when the internal shared document was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The login user name associated with the user who last updated the internal shared document. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
The name of the user who last updated the internal shared document. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
The title of the internal shared document. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The uploaded file content type of the internal shared document. -
UploadedFileLength: integer
Title:
File Size
The uploaded file length of the internal shared document. -
UploadedFileName: string
Title:
Uploaded File Name
The uploaded file name of the internal shared document. -
UploadedText: string
Title:
Uploaded Text
The uploaded text of the internal shared document. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of the internal shared document. -
Url: string
Title:
Url
Maximum Length:4000
The URL of the internal shared document. A file name or URL is required. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
The name of the category to which the internal shared document is assigned.
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.