Jump to

• Request
• Response

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: 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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• CategoryName: string
  Title: Category

  Maximum Length: 30

  The name of the category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicate if the attachment is shared.
• 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.

{ "type":"object", "properties":{ "ErrorStatusMessage":{ "title":"Error Status Message", "type":"string", "description":"The error status message of the attachment.", "nullable":true, "x-queryable":false, "x-hints":{ "includeInCompactView":true, "fnd:FND_AUDIT_ATTR_ENABLED":"false" } }, "Description":{ "title":"Description", "maxLength":255, "type":"string", "description":"Description of the attachment assigned to the award.", "nullable":true, "x-queryable":false, "x-hints":{ "includeInCompactView":true, "fnd:FND_AUDIT_ATTR_ENABLED":"false" } }, "DatatypeCode":{ "title":"Type", "maxLength":30, "type":"string", "description":"Type of the attachment.", "nullable":false, "default":"FILE", "x-hints":{ "includeInCompactView":true, "fnd:FND_AUDIT_ATTR_ENABLED":"true" } }, "FileName":{ "title":"File Name", "maxLength":2048, "type":"string", "description":"Name of the attachment.", "nullable":true, "x-hints":{ "includeInCompactView":true, "fnd:FND_AUDIT_ATTR_ENABLED":"true" } }, "PostProcessingAction":{ "title":"PostProcessingAction", "type":"string", "description":"The name of the action that can be performed after an attachment is uploaded.", "nullable":true, "x-queryable":false, "x-hints":{ "includeInCompactView":true, "fnd:FND_AUDIT_ATTR_ENABLED":"false" } }, "Title":{ "title":"Title", "type":"string", "description":"Name of the attachment assigned to the award.", "nullable":true, "x-queryable":false, "x-hints":{ "includeInCompactView":true, "fnd:FND_AUDIT_ATTR_ENABLED":"false" } }, "Uri":{ "title":"Uri", "maxLength":4000, "type":"string", "description":"The URI of the attachment when the attachment type is URI.", "nullable":true, "x-hints":{ "includeInCompactView":true, "fnd:FND_AUDIT_ATTR_ENABLED":"false" } }, "Url":{ "title":"Url", "maxLength":4000, "type":"string", "description":"The URL of the attachment when the attachment type is URL.", "nullable":true, "x-hints":{ "includeInCompactView":true, "fnd:FND_AUDIT_ATTR_ENABLED":"true" } }, "UploadedFileName":{ "title":"Uploaded File Name", "type":"string", "description":"The size of the attachment.", "nullable":true, "x-queryable":false, "x-hints":{ "includeInCompactView":true, "fnd:FND_AUDIT_ATTR_ENABLED":"false" } }, "DmDocumentId":{ "maxLength":255, "type":"string", "description":"The unique identifier of the attachment.", "nullable":true, "x-hints":{ "includeInCompactView":true, "fnd:FND_AUDIT_ATTR_ENABLED":"true", "fnd:OA_TRANSLATABLE":"true" } }, "FileUrl":{ "title":"File Url", "type":"string", "description":"The URL of the attachment when the attachment type is URL.", "nullable":true, "x-queryable":false, "x-hints":{ "includeInCompactView":true, "fnd:FND_AUDIT_ATTR_ENABLED":"false" } }, "ContentRepositoryFileShared":{ "title":"Shared", "type":"boolean", "description":"Indicate if the attachment is shared.", "nullable":true, "x-queryable":false, "x-hints":{ "includeInCompactView":true, "fnd:FND_AUDIT_ATTR_ENABLED":"false" } }, "FileContents":{ "title":"File Contents", "type":"string", "description":"The type of attachment files such as.pdf,.xls, when the attachment type is File.", "format":"byte", "nullable":true, "x-queryable":false, "x-hints":{ "XML_ELEMENT":"#hide" } }, "UploadedFileContentType":{ "title":"Uploaded File Content Type", "type":"string", "description":"The type of the attachment such as URL, file or text provided at the award or award project level.", "nullable":true, "x-queryable":false, "x-hints":{ "includeInCompactView":true, "fnd:FND_AUDIT_ATTR_ENABLED":"false" } }, "ExpirationDate":{ "title":"Expiration Date", "type":"string", "description":"The expiration date of the attachment.", "format":"date-time", "nullable":true, "x-hints":{ "includeInCompactView":true } }, "ErrorStatusCode":{ "title":"Error Status Code", "type":"string", "description":"The error status code of the attachment.", "nullable":true, "x-queryable":false, "x-hints":{ "includeInCompactView":true, "fnd:FND_AUDIT_ATTR_ENABLED":"false" } }, "DownloadInfo":{ "title":"DownloadInfo", "type":"string", "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.", "nullable":true, "x-queryable":false, "x-hints":{ "includeInCompactView":true, "fnd:FND_AUDIT_ATTR_ENABLED":"false" } }, "DmFolderPath":{ "title":"Dm Folder Path", "maxLength":1000, "type":"string", "description":"The direct folder path of the attachment.", "nullable":true, "x-hints":{ "includeInCompactView":true, "fnd:FND_AUDIT_ATTR_ENABLED":"true" } }, "UploadedText":{ "title":"Uploaded Text", "type":"string", "description":"The uploaded text of the attachment.", "nullable":true, "x-queryable":false, "x-hints":{ "includeInCompactView":true, "fnd:FND_AUDIT_ATTR_ENABLED":"false" } }, "CategoryName":{ "title":"Category", "maxLength":30, "type":"string", "description":"The name of the category of the attachment.", "nullable":true, "x-hints":{ "includeInCompactView":true, "fnd:FND_AUDIT_ATTR_ENABLED":"true" } }, "UploadedFileLength":{ "title":"File Size", "type":"integer", "description":"The name of the file uploaded.", "nullable":true, "x-queryable":false, "x-hints":{ "includeInCompactView":true, "fnd:FND_AUDIT_ATTR_ENABLED":"false" } }, "DmVersionNumber":{ "maxLength":255, "type":"string", "description":"The version number of the attachment.", "nullable":true, "x-hints":{ "includeInCompactView":true, "fnd:FND_AUDIT_ATTR_ENABLED":"true" } } } }

Back to Top

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.

Body ()

Root Schema : awards-Attachment-item-response

Type: object

Show Source

• 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
  Title: Shared

  Indicate if the attachment is shared.
• 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.

{ "type":"object", "properties":{ "CreationDate":{ "title":"Creation Date", "type":"string", "description":"The creation date of the attachment.", "format":"date-time", "nullable":false, "readOnly":true, "x-hints":{ "includeInCompactView":true }, "x-queryable":true }, "Description":{ "title":"Description", "maxLength":255, "type":"string", "description":"Description of the attachment assigned to the award.", "nullable":true, "x-queryable":false, "x-hints":{ "includeInCompactView":true, "fnd:FND_AUDIT_ATTR_ENABLED":"false" } }, "FileName":{ "title":"File Name", "maxLength":2048, "type":"string", "description":"Name of the attachment.", "nullable":true, "x-hints":{ "includeInCompactView":true, "fnd:FND_AUDIT_ATTR_ENABLED":"true" }, "x-queryable":true }, "FileWebImage":{ "title":"File Web Image", "type":"string", "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.", "format":"byte", "nullable":true, "readOnly":true, "x-queryable":false, "x-hints":{ "XML_ELEMENT":"#hide", "PAYLOADHINT":"Show" } }, "Uri":{ "title":"Uri", "maxLength":4000, "type":"string", "description":"The URI of the attachment when the attachment type is URI.", "nullable":true, "x-hints":{ "includeInCompactView":true, "fnd:FND_AUDIT_ATTR_ENABLED":"false" }, "x-queryable":true }, "Url":{ "title":"Url", "maxLength":4000, "type":"string", "description":"The URL of the attachment when the attachment type is URL.", "nullable":true, "x-hints":{ "includeInCompactView":true, "fnd:FND_AUDIT_ATTR_ENABLED":"true" }, "x-queryable":true }, "DmDocumentId":{ "maxLength":255, "type":"string", "description":"The unique identifier of the attachment.", "nullable":true, "x-hints":{ "includeInCompactView":true, "fnd:FND_AUDIT_ATTR_ENABLED":"true", "fnd:OA_TRANSLATABLE":"true" }, "x-queryable":true }, "AttachedDocumentId":{ "title":"Attached Document Id", "type":"integer", "description":"Unique identifier of the attachment.", "format":"int64", "nullable":false, "x-hints":{ "includeInCompactView":true, "precision":18, "fnd:FND_AUDIT_ATTR_ENABLED":"true", "fnd:GLOBALLY_UNIQUE":"true" }, "x-queryable":true }, "UploadedFileContentType":{ "title":"Uploaded File Content Type", "type":"string", "description":"The type of the attachment such as URL, file or text provided at the award or award project level.", "nullable":true, "x-queryable":false, "x-hints":{ "includeInCompactView":true, "fnd:FND_AUDIT_ATTR_ENABLED":"false" } }, "DownloadInfo":{ "title":"DownloadInfo", "type":"string", "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.", "nullable":true, "x-queryable":false, "x-hints":{ "includeInCompactView":true, "fnd:FND_AUDIT_ATTR_ENABLED":"false" } }, "CreatedByUserName":{ "title":"Created By User Name", "type":"string", "description":"The user that created the attachment.", "nullable":true, "readOnly":true, "x-hints":{ "includeInCompactView":true, "fnd:FND_AUDIT_ATTR_ENABLED":"false" }, "x-queryable":true }, "links":{ "title":"Links", "type":"array", "description":"The link relations associated with the resource instance.", "items":{ "$ref":"#/components/schemas/link" } }, "UploadedFileLength":{ "title":"File Size", "type":"integer", "description":"The name of the file uploaded.", "nullable":true, "x-queryable":false, "x-hints":{ "includeInCompactView":true, "fnd:FND_AUDIT_ATTR_ENABLED":"false" } }, "DmVersionNumber":{ "maxLength":255, "type":"string", "description":"The version number of the attachment.", "nullable":true, "x-hints":{ "includeInCompactView":true, "fnd:FND_AUDIT_ATTR_ENABLED":"true" }, "x-queryable":true }, "LastUpdatedBy":{ "title":"Last Updated By", "maxLength":255, "type":"string", "description":"User that last updated the attachment.", "nullable":false, "readOnly":true, "x-hints":{ "includeInCompactView":true }, "x-queryable":true }, "ErrorStatusMessage":{ "title":"Error Status Message", "type":"string", "description":"The error status message of the attachment.", "nullable":true, "x-queryable":false, "x-hints":{ "includeInCompactView":true, "fnd:FND_AUDIT_ATTR_ENABLED":"false" } }, "UserName":{ "title":"User Name", "maxLength":255, "type":"string", "description":"The user name of the owner of the attachment.", "nullable":false, "readOnly":true, "x-hints":{ "includeInCompactView":true, "fnd:FND_AUDIT_ATTR_ENABLED":"false" }, "x-queryable":true }, "CreatedBy":{ "title":"Created By", "maxLength":255, "type":"string", "description":"The user that created the attachment.", "nullable":false, "readOnly":true, "x-hints":{ "includeInCompactView":true }, "x-queryable":true }, "DatatypeCode":{ "title":"Type", "maxLength":30, "type":"string", "description":"Type of the attachment.", "nullable":false, "default":"FILE", "x-hints":{ "includeInCompactView":true, "fnd:FND_AUDIT_ATTR_ENABLED":"true" }, "x-queryable":true }, "PostProcessingAction":{ "title":"PostProcessingAction", "type":"string", "description":"The name of the action that can be performed after an attachment is uploaded.", "nullable":true, "x-queryable":false, "x-hints":{ "includeInCompactView":true, "fnd:FND_AUDIT_ATTR_ENABLED":"false" } }, "Title":{ "title":"Title", "type":"string", "description":"Name of the attachment assigned to the award.", "nullable":true, "x-queryable":false, "x-hints":{ "includeInCompactView":true, "fnd:FND_AUDIT_ATTR_ENABLED":"false" } }, "LastUpdatedByUserName":{ "title":"Last Updated By User", "type":"string", "description":"The user that last updated the attachment.", "nullable":true, "readOnly":true, "x-hints":{ "includeInCompactView":true, "fnd:FND_AUDIT_ATTR_ENABLED":"false" }, "x-queryable":true }, "UploadedFileName":{ "title":"Uploaded File Name", "type":"string", "description":"The size of the attachment.", "nullable":true, "x-queryable":false, "x-hints":{ "includeInCompactView":true, "fnd:FND_AUDIT_ATTR_ENABLED":"false" } }, "FileUrl":{ "title":"File Url", "type":"string", "description":"The URL of the attachment when the attachment type is URL.", "nullable":true, "x-queryable":false, "x-hints":{ "includeInCompactView":true, "fnd:FND_AUDIT_ATTR_ENABLED":"false" } }, "ContentRepositoryFileShared":{ "title":"Shared", "type":"boolean", "description":"Indicate if the attachment is shared.", "nullable":true, "x-queryable":false, "x-hints":{ "includeInCompactView":true, "fnd:FND_AUDIT_ATTR_ENABLED":"false" } }, "FileContents":{ "title":"File Contents", "type":"string", "description":"The type of attachment files such as.pdf,.xls, when the attachment type is File.", "format":"byte", "nullable":true, "x-queryable":false, "x-hints":{ "XML_ELEMENT":"#hide" } }, "ExpirationDate":{ "title":"Expiration Date", "type":"string", "description":"The expiration date of the attachment.", "format":"date-time", "nullable":true, "x-hints":{ "includeInCompactView":true }, "x-queryable":true }, "ErrorStatusCode":{ "title":"Error Status Code", "type":"string", "description":"The error status code of the attachment.", "nullable":true, "x-queryable":false, "x-hints":{ "includeInCompactView":true, "fnd:FND_AUDIT_ATTR_ENABLED":"false" } }, "DmFolderPath":{ "title":"Dm Folder Path", "maxLength":1000, "type":"string", "description":"The direct folder path of the attachment.", "nullable":true, "x-hints":{ "includeInCompactView":true, "fnd:FND_AUDIT_ATTR_ENABLED":"true" }, "x-queryable":true }, "UploadedText":{ "title":"Uploaded Text", "type":"string", "description":"The uploaded text of the attachment.", "nullable":true, "x-queryable":false, "x-hints":{ "includeInCompactView":true, "fnd:FND_AUDIT_ATTR_ENABLED":"false" } }, "CategoryName":{ "title":"Category", "maxLength":30, "type":"string", "description":"The name of the category of the attachment.", "nullable":true, "x-hints":{ "includeInCompactView":true, "fnd:FND_AUDIT_ATTR_ENABLED":"true" }, "x-queryable":true }, "LastUpdateDate":{ "title":"Last Update Date", "type":"string", "description":"Date when the document was last updated.", "format":"date-time", "nullable":false, "readOnly":true, "x-hints":{ "includeInCompactView":true, "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss" }, "x-queryable":true }, "AsyncTrackerId":{ "title":"Asynchronous Upload Tracker Id", "type":"string", "description":"An identifier used for tracking the uploaded files.", "nullable":true, "x-queryable":false, "x-hints":{ "DISPLAYHINT":"Hide", "includeInCompactView":true, "PAYLOADHINT":"Show" } } } }

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{ "title":"Links", "type":"array", "description":"The link relations associated with the resource instance.", "items":{ "$ref":"#/components/schemas/link" } }

Nested Schema : link

Type: object

Show Source

• 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.

{ "type":"object", "properties":{ "kind":{ "title":"kind", "type":"string", "description":"The kind of the related resource.", "enum":[ "collection", "item", "describe", "other" ] }, "rel":{ "title":"relation", "type":"string", "description":"The name of the relation to the resource instance. Example: self.", "enum":[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ] }, "name":{ "title":"name", "type":"string", "description":"The name of the link to the related resource." }, "href":{ "title":"hyperlink reference", "type":"string", "description":"The URI to the related resource." }, "properties":{ "type":"object", "properties":{ "changeIndicator":{ "type":"string", "description":"Change indicator or the ETag value of the resource instance." } } } } }

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{ "type":"object", "properties":{ "changeIndicator":{ "type":"string", "description":"Change indicator or the ETag value of the resource instance." } } }

Back to Top