Create a set of workflow attachments
post
/fscmRestApi/resources/11.13.18.05/publicSectorPcsAttachments
Request
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The unique identifier of the agency. -
AttachmentEntityName: string
Default Value:
PSC_DOC_PCS
The entity name that is used by the Attachments framework. -
AttachmentId: integer
(int64)
The unique identifier of the attachment.
-
AttachmentType: string
Maximum Length:
15
Default Value:PCS
The file type of the attachment. -
ConfidentialFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether the attachment is a confidential document. The default value is N for no. -
CreatedByName: string
Title:
Uploaded By
The name of the user who created the attachment. -
Description: string
Title:
Description
Maximum Length:100
The description about the attachment. -
FileContentUploadedFlag: boolean
Maximum Length:
1
Default Value:false
Indicates 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(required): string
Title:
File Name
Maximum Length:255
The file name of the attachment. -
FileSize(required): integer
(int64)
Title:
File Size
The file size of the attachment. -
FileType: string
Maximum Length:
100
The column that is used to indicate the file type. -
LnpRecordKey(required): integer
(int64)
The unique identifier of the record that is associated with attachment.
-
PcsAttachmentAccessor: array
Attachments
Title:
Attachments
The attachments resource is used to perform the file attachment functionality. -
PcsAttachmentId(required): integer
(int64)
The unique identifier of the attachment.
-
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:
1
Default Value:false
Indicates whether the attachment is a required document. The default value is N for no. -
TaskId(required): string
Maximum Length:
100
The unique identifier of the workflow task that is associated with the attachment. -
TaskStatus: string
Maximum Length:
50
The status of the workflow task that is associated with the attachment. -
UpdatedByName: string
Title:
Last Updated By
The name of the user who last updated the attachment. -
Version(required): integer
(int32)
The version of the file.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to perform the file attachment functionality.
Show Source
Nested Schema : publicSectorPcsAttachments-PcsAttachmentAccessor-item-post-request
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The attached document ID that is used by the Attachments framework. -
AttachmentsRevision: array
Attachment Revisions
Title:
Attachment Revisions
The attachment revisions resource is used to access all the revision versions of the attachment. -
CategoryName: string
Title:
Category
Maximum Length:30
The category name of the attachment that is used by the Attachments framework. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
The data type code that is used by the Attachments framework.. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment that is used by the Attachments framework. -
DmDocumentId: string
Maximum Length:
255
The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path of the attachment that is used by the Attachments framework. -
DmVersionNumber: string
Maximum Length:
255
The document version number from which the attachment is created. -
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 that is used by the Attachments framework. -
ErrorStatusMessage: string
Title:
Error Status Message
The error status message of the attachment that is used by the Attachments framework. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The expiration date of the attachment that is used by the Attachments framework. -
FileContents: string
(byte)
Title:
File Contents
The 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 Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URL of the attachment file that is used by the Attachments framework. -
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 attachment that is used by the Attachments framework. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The 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 Size
The 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 Name
The 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 Text
The uploaded text from the attachment that is used by the Attachments framework. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of the attachment that is used by the Attachments framework. -
Url: string
Title:
Url
Maximum Length:4000
The URL of the attachment that is used by the Attachments framework.
Nested Schema : Attachment Revisions
Type:
array
Title:
Attachment Revisions
The attachment revisions resource is used to access all the revision versions of the attachment.
Show Source
Nested Schema : publicSectorPcsAttachments-PcsAttachmentAccessor-AttachmentsRevision-item-post-request
Type:
Show Source
object
-
ContentId: string
Maximum Length:
80
The content ID of the attachment that is used by the Attachments framework. -
ErrorStatusCode: string
The error status code of the attachment that is used by the Attachments framework.
-
ErrorStatusMessage: string
The error status message of the attachment that is used by the Attachments framework.
-
FileUrl: string
The URL of the attachment file that is used by the Attachments framework.
-
Format: string
Maximum Length:
128
The format of the attachment that is used by the Attachments framework. -
InDate: string
(date-time)
The entry date of the attachment that is used by the Attachments framework.
-
RevisionId: string
Maximum Length:
80
The revision ID of the attachment that is used by the Attachments framework. -
RevLabel: string
Maximum Length:
80
The revision label of the attachment that is used by the Attachments framework. -
UserRevisionId: integer
The user revision ID of the attachment that is used by the Attachments framework.
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 : publicSectorPcsAttachments-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The unique identifier of the agency. -
AttachmentEntityName: string
Default Value:
PSC_DOC_PCS
The entity name that is used by the Attachments framework. -
AttachmentId: integer
(int64)
The unique identifier of the attachment.
-
AttachmentType: string
Maximum Length:
15
Default Value:PCS
The file type of the attachment. -
ConfidentialFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether the attachment is a confidential document. The default value is N for no. -
CreatedByName: string
Title:
Uploaded By
The name of the user who created the attachment. -
CreationDate: string
(date-time)
Title:
Uploaded On
Read Only:true
The date and time when the row was created. -
Description: string
Title:
Description
Maximum Length:100
The description about the attachment. -
FileContentUploadedFlag: boolean
Maximum Length:
1
Default Value:false
Indicates 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 Name
Maximum Length:255
The file name of the attachment. -
FileSize: integer
(int64)
Title:
File Size
The file size of the attachment. -
FileType: string
Maximum Length:
100
The column that is used to indicate the file type. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the row was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LnpRecordKey: integer
(int64)
The unique identifier of the record that is associated with attachment.
-
PcsAttachmentAccessor: array
Attachments
Title:
Attachments
The attachments resource is used to perform the file attachment functionality. -
PcsAttachmentId: integer
(int64)
The unique identifier of the attachment.
-
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:
1
Default Value:false
Indicates whether the attachment is a required document. The default value is N for no. -
TaskId: string
Maximum Length:
100
The unique identifier of the workflow task that is associated with the attachment. -
TaskStatus: string
Maximum Length:
50
The status of the workflow task that is associated with the attachment. -
UpdatedByName: string
Title:
Last Updated By
The name of the user who last updated the attachment. -
Version: integer
(int32)
The version of the file.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to perform the file attachment functionality.
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.
Nested Schema : publicSectorPcsAttachments-PcsAttachmentAccessor-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The attached document ID that is used by the Attachments framework. -
AttachmentsRevision: array
Attachment Revisions
Title:
Attachment Revisions
The attachment revisions resource is used to access all the revision versions of the attachment. -
CategoryName: string
Title:
Category
Maximum Length:30
The category name of the attachment that is used by the Attachments framework. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The name of the user who created the row. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
The name of the user who created the attachment that is used by the Attachments framework. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the row was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
The data type code that is used by the Attachments framework.. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment that is used by the Attachments framework. -
DmDocumentId: string
Maximum Length:
255
The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path of the attachment that is used by the Attachments framework. -
DmVersionNumber: string
Maximum Length:
255
The document version number from which the attachment is created. -
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 that is used by the Attachments framework. -
ErrorStatusMessage: string
Title:
Error Status Message
The error status message of the attachment that is used by the Attachments framework. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The expiration date of the attachment that is used by the Attachments framework. -
FileContents: string
(byte)
Title:
File Contents
The 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 Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URL of the attachment file that is used by the Attachments framework. -
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 and time when the row was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The name of the user who last updated the row. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
The name of the user who last updated the attachment that is used by the Attachments framework. -
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 attachment that is used by the Attachments framework. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The 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 Size
The 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 Name
The 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 Text
The uploaded text from the attachment that is used by the Attachments framework. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of the attachment that is used by the Attachments framework. -
Url: string
Title:
Url
Maximum Length:4000
The URL of the attachment that is used by the Attachments framework. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
The user name that is used by the Attachments framework.
Nested Schema : Attachment Revisions
Type:
array
Title:
Attachment Revisions
The attachment revisions resource is used to access all the revision versions of the attachment.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorPcsAttachments-PcsAttachmentAccessor-AttachmentsRevision-item-response
Type:
Show Source
object
-
AttachedDocumentId: string
Read Only:
true
The attached document ID of the attachment that is used by the Attachments framework. -
ContentId: string
Maximum Length:
80
The content ID of the attachment that is used by the Attachments framework. -
ErrorStatusCode: string
The error status code of the attachment that is used by the Attachments framework.
-
ErrorStatusMessage: string
The error status message of the attachment that is used by the Attachments framework.
-
FileUrl: string
The URL of the attachment file that is used by the Attachments framework.
-
Format: string
Maximum Length:
128
The format of the attachment that is used by the Attachments framework. -
InDate: string
(date-time)
The entry date of the attachment that is used by the Attachments framework.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RevisionId: string
Maximum Length:
80
The revision ID of the attachment that is used by the Attachments framework. -
RevLabel: string
Maximum Length:
80
The revision label of the attachment that is used by the Attachments framework. -
UserRevisionId: integer
The user revision ID of the attachment that is used by the Attachments framework.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- PcsAttachmentAccessor
-
Parameters:
- publicSectorPcsAttachmentsUniqID:
$request.path.publicSectorPcsAttachmentsUniqID
The attachments resource is used to perform the file attachment functionality. - publicSectorPcsAttachmentsUniqID: