Update a conditions of approval attachment
patch
/fscmRestApi/resources/11.13.18.05/publicSectorConditionAttachments/{AttachmentKey}
Request
Path Parameters
-
AttachmentKey(required): integer(int64)
The unique identifier of the attached document.
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-
AttachmentEntityName: string
Default Value:
PSC_DOC_COAThe name which identifies the type of attachments being uploaded. -
AttachmentPuid: string
Maximum Length:
480The public unique identifier of the migrated attachment. -
COAAttachmentAccessor: array
Attachments
Title:
AttachmentsThe attachments resource is used to view, create, and update attachments. -
CoaPuid: string
Maximum Length:
480The public unique identifier of the migrated condition of approval. -
ConfidentialFlag: boolean
Maximum Length:
1Default Value:falseIndicates whether the attachment is a confidential document. The default value is N for no. -
CreatedByName: string
Title:
Uploaded ByThe name of the person who created the file. -
Description: string
Title:
DescriptionMaximum Length:100The description of the attachment. -
DocCategory: string
Maximum Length:
30The user defined category for organizing the documents. -
DocSubcategory: string
Maximum Length:
30The user defined sub category for organizing the documents. -
FileContentUploadedFlag: boolean
Maximum Length:
1Default Value:falseIndicates whether the attachment file contents has been successfully uploaded. The default value is N for no. The core attachments API has been restructured for attachments insert functionality. See Document 3034288.1 in My Oracle Support. -
MigratedDataFlag: string
Maximum Length:
3Indicates whether the transaction was created online or migrated from a legacy system. -
Preview: string
(byte)
This column contains the thumbnail of an attached file.
-
PreviewHeight: number
This column indicates the height of a stored thumbnail.
-
PreviewWidth: number
This column indicates the width of a stored thumbnail.
-
RequiredFlag: boolean
Maximum Length:
1Default Value:falseIndicates whether the attachment is a required document. The default value is N for no. -
UpdatedByName: string
Title:
Last Updated ByThe name of the person who last updated the file. -
Version: integer
(int32)
The identifier to indicate the version of the fie being uploaded to attachment.
Nested Schema : Attachments
Type:
arrayTitle:
AttachmentsThe attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : schema
Type:
Show Source
object-
AttachmentsRevision: array
Attachment Revisions
Title:
Attachment RevisionsThe attachment revision resource is used to view attachment revisions. -
CategoryName: string
Title:
CategoryMaximum Length:30The category of the attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEA value that indicates the data type. -
Description: string
Title:
DescriptionMaximum Length:255The description of the attachment. -
DmDocumentId: string
Maximum Length:
255The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255The document version number from which the attachment is created. -
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 code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageThe error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateThe expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File ContentsThe core attachments API has been restructured and this attribute is no longer supported for attachments insert functionality. Use these attributes instead: UploadedFileContentType, UploadedFileLength, and UploadedFileName. See Document 3034288.1 in My Oracle Support. -
FileName: string
Title:
File NameMaximum Length:2048The file name of the attachment. -
FileUrl: string
Title:
File UrlThe URL of the file. -
PostProcessingAction: string
Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleThe title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeThe content type of the attachment, such as text/plain or csv. The core attachments API has been restructured and this attribute is now required for attachments insert functionality. See Document 3034288.1 in My Oracle Support. -
UploadedFileLength: integer
Title:
File SizeThe file length of the attachment in bytes. The core attachments API has been restructured and this attribute is now required for attachments insert functionality. See Document 3034288.1 in My Oracle Support. -
UploadedFileName: string
Title:
Uploaded File NameThe name of the attached file. The core attachments API has been restructured and this attribute is now required for attachments insert functionality. See Document 3034288.1 in My Oracle Support. -
UploadedText: string
Title:
Uploaded TextThe text content for a new text attachment. -
Uri: string
Title:
UriMaximum Length:4000The URI of a Topology Manager type attachment. -
Url: string
Title:
UrlMaximum Length:4000The URL of a web page type attachment.
Nested Schema : Attachment Revisions
Type:
arrayTitle:
Attachment RevisionsThe attachment revision resource is used to view attachment revisions.
Show Source
Nested Schema : schema
Type:
Show Source
object-
ContentId: string
Maximum Length:
80The contents of the attachment revision. -
ErrorStatusCode: string
The error code, if any, for the attachment revision.
-
ErrorStatusMessage: string
The error message, if any, for the attachment revision.
-
FileUrl: string
The file name of the attachment revision.
-
Format: string
Maximum Length:
128The format of the attachment revision. -
InDate: string
(date-time)
The date of the attachment revision.
-
RevLabel: string
Maximum Length:
80The revision label of the attachment revision. -
UserRevisionId: integer
The user revision identifier for the attachment revision.
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 : publicSectorConditionAttachments-item-response
Type:
Show Source
object-
AgencyId: integer
(int32)
Title:
Agency IDDefault Value:1The unique identifier of the agency. -
AttachmentEntityName: string
Default Value:
PSC_DOC_COAThe name which identifies the type of attachments being uploaded. -
AttachmentId: integer
(int64)
The unique identifier of the attached document.
-
AttachmentKey: integer
(int64)
The unique identifier of the attached document.
-
AttachmentPuid: string
Maximum Length:
480The public unique identifier of the migrated attachment. -
AttachmentType: string
Maximum Length:
15Default Value:COAThe identifier to determine the type of the attachment. -
COAAttachmentAccessor: array
Attachments
Title:
AttachmentsThe attachments resource is used to view, create, and update attachments. -
COAAttachmentId: integer
(int64)
The unique identifier of the attached document.
-
CoaKey: integer
(int64)
The unique identifier of the attached document.
-
CoaPuid: string
Maximum Length:
480The public unique identifier of the migrated condition of approval. -
ConfidentialFlag: boolean
Maximum Length:
1Default Value:falseIndicates whether the attachment is a confidential document. The default value is N for no. -
CreatedByName: string
Title:
Uploaded ByThe name of the person who created the file. -
CreationDate: string
(date-time)
Title:
Uploaded OnRead Only:trueThe date when the record was created. -
Description: string
Title:
DescriptionMaximum Length:100The description of the attachment. -
DocCategory: string
Maximum Length:
30The user defined category for organizing the documents. -
DocSubcategory: string
Maximum Length:
30The user defined sub category for organizing the documents. -
FileContentUploadedFlag: boolean
Maximum Length:
1Default Value:falseIndicates whether the attachment file contents has been successfully uploaded. The default value is N for no. The core attachments API has been restructured for attachments insert functionality. See Document 3034288.1 in My Oracle Support. -
FileName: string
Title:
File NameMaximum Length:255The name to assign to a new attachment file. -
FileSize: integer
(int64)
Title:
File SizeThe computed size of the attachment. -
FileType: string
Maximum Length:
100The identifier to determine the type of the attachment file. -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueThe date when the record was last updated. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MigratedDataFlag: string
Maximum Length:
3Indicates whether the transaction was created online or migrated from a legacy system. -
Preview: string
(byte)
This column contains the thumbnail of an attached file.
-
PreviewHeight: number
This column indicates the height of a stored thumbnail.
-
PreviewWidth: number
This column indicates the width of a stored thumbnail.
-
RequiredFlag: boolean
Maximum Length:
1Default Value:falseIndicates whether the attachment is a required document. The default value is N for no. -
UpdatedByName: string
Title:
Last Updated ByThe name of the person who last updated the file. -
Version: integer
(int32)
The identifier to indicate the version of the fie being uploaded to attachment.
Nested Schema : Attachments
Type:
arrayTitle:
AttachmentsThe attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorConditionAttachments-COAAttachmentAccessor-item-response
Type:
Show Source
object-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdThe attribute provided for exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdThe unique identifier of the attached document. -
AttachmentsRevision: array
Attachment Revisions
Title:
Attachment RevisionsThe attachment revision resource is used to view attachment revisions. -
CategoryName: string
Title:
CategoryMaximum Length:30The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255The user who created the record. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueThe user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the record was created. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEA value that indicates the data type. -
Description: string
Title:
DescriptionMaximum Length:255The description of the attachment. -
DmDocumentId: string
Maximum Length:
255The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255The document version number from which the attachment is created. -
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 code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageThe error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateThe expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File ContentsThe core attachments API has been restructured and this attribute is no longer supported for attachments insert functionality. Use these attributes instead: UploadedFileContentType, UploadedFileLength, and UploadedFileName. See Document 3034288.1 in My Oracle Support. -
FileName: string
Title:
File NameMaximum Length:2048The file name of the attachment. -
FileUrl: string
Title:
File UrlThe URL of the file. -
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 date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueThe user name 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:
TitleThe title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeThe content type of the attachment, such as text/plain or csv. The core attachments API has been restructured and this attribute is now required for attachments insert functionality. See Document 3034288.1 in My Oracle Support. -
UploadedFileLength: integer
Title:
File SizeThe file length of the attachment in bytes. The core attachments API has been restructured and this attribute is now required for attachments insert functionality. See Document 3034288.1 in My Oracle Support. -
UploadedFileName: string
Title:
Uploaded File NameThe name of the attached file. The core attachments API has been restructured and this attribute is now required for attachments insert functionality. See Document 3034288.1 in My Oracle Support. -
UploadedText: string
Title:
Uploaded TextThe text content for a new text attachment. -
Uri: string
Title:
UriMaximum Length:4000The URI of a Topology Manager type attachment. -
Url: string
Title:
UrlMaximum Length:4000The URL of a web page type attachment. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255The login credentials of the user who created the attachment.
Nested Schema : Attachment Revisions
Type:
arrayTitle:
Attachment RevisionsThe attachment revision resource is used to view attachment revisions.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorConditionAttachments-COAAttachmentAccessor-AttachmentsRevision-item-response
Type:
Show Source
object-
AttachedDocumentId: string
Read Only:
trueThe unique identifier of the attached document for this revision. -
ContentId: string
Maximum Length:
80The contents of the attachment revision. -
ErrorStatusCode: string
The error code, if any, for the attachment revision.
-
ErrorStatusMessage: string
The error message, if any, for the attachment revision.
-
FileUrl: string
The file name of the attachment revision.
-
Format: string
Maximum Length:
128The format of the attachment revision. -
InDate: string
(date-time)
The date of the attachment revision.
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
RevisionId: string
Maximum Length:
80The identifier of the attachment revision. -
RevLabel: string
Maximum Length:
80The revision label of the attachment revision. -
UserRevisionId: integer
The user revision identifier for the attachment revision.
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.
Links
- COAAttachmentAccessor
-
Parameters:
- AttachmentKey:
$request.path.AttachmentKey
The attachments resource is used to view, create, and update attachments. - AttachmentKey: