Update an award attachment
patch
/fscmRestApi/resources/11.13.18.05/awards/{AwardId}/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 Award Attachments resource and used to uniquely identify an instance of Award Attachments. The client should not generate the hash key value. Instead, the client should query on the Award Attachments collection resource in order to navigate to a specific instance of Award Attachments to get the hash key.
-
AwardId(required): integer(int64)
Unique identifier of the award.
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 name of the category of the attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Type of the attachment. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment assigned to the award. -
DmDocumentId: string
Maximum Length:
255
The unique identifier of the attachment. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The direct folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
The version number of the attachment. -
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. -
ErrorStatusMessage: string
Title:
Error Status Message
The error status message of the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The expiration date of the attachment. -
FileContents: string
(byte)
Title:
File Contents
The type of attachment files such as.pdf,.xls, when the attachment type is File. -
FileName: string
Title:
File Name
Maximum Length:2048
Name of the attachment. -
FileUrl: string
Title:
File Url
The URL of the attachment when the attachment type is URL. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
Name of the attachment assigned to the award. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The type of the attachment such as URL, file or text provided at the award or award project level. -
UploadedFileLength: integer
Title:
File Size
The name of the file uploaded. -
UploadedFileName: string
Title:
Uploaded File Name
The size of the attachment. -
UploadedText: string
Title:
Uploaded Text
The uploaded text of the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of the attachment when the attachment type is URI. -
Url: string
Title:
Url
Maximum Length:4000
The URL of the attachment when 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 : awards-Attachment-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
An identifier used for tracking the uploaded files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
Unique identifier of the attachment. -
CategoryName: string
Title:
Category
Maximum Length:30
The name of the category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user that created the attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
The user that created the attachment. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The creation date of the attachment. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Type of the attachment. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment assigned to the award. -
DmDocumentId: string
Maximum Length:
255
The unique identifier of the attachment. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The direct folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
The version number of the attachment. -
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. -
ErrorStatusMessage: string
Title:
Error Status Message
The error status message of the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The expiration date of the attachment. -
FileContents: string
(byte)
Title:
File Contents
The type of attachment files such as.pdf,.xls, when the attachment type is File. -
FileName: string
Title:
File Name
Maximum Length:2048
Name of the attachment. -
FileUrl: string
Title:
File Url
The URL of the attachment when the attachment type is URL. -
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
Date when the document was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
User that last updated the attachment. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
The user that last updated the attachment. -
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
Name of the attachment assigned to the award. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The type of the attachment such as URL, file or text provided at the award or award project level. -
UploadedFileLength: integer
Title:
File Size
The name of the file uploaded. -
UploadedFileName: string
Title:
Uploaded File Name
The size of the attachment. -
UploadedText: string
Title:
Uploaded Text
The uploaded text of the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of the attachment when the attachment type is URI. -
Url: string
Title:
Url
Maximum Length:4000
The URL of the attachment when the attachment type is URL. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
The user name of the owner of the attachment.
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.