Create an attachment
post
/hcmRestApi/resources/11.13.18.05/checkInDocuments/{checkInDocumentsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{questionResponsesUniqID}/child/responseAttachments
Request
Path Parameters
-
QuestionnaireResponseId(required): integer(int64)
System-generated primary key for the response to a questionnaire.
-
checkInDocumentsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Check-In Documents resource and used to uniquely identify an instance of Check-In Documents. The client should not generate the hash key value. Instead, the client should query on the Check-In Documents collection resource in order to navigate to a specific instance of Check-In Documents to get the hash key.
-
questionResponsesUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Question Responses resource and used to uniquely identify an instance of Question Responses. The client should not generate the hash key value. Instead, the client should query on the Question Responses collection resource in order to navigate to a specific instance of Question Responses 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.
-
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
-
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
Unique identifier of the attachment. It is a child of the question response. There can be zero to many attachments in a question response. -
CategoryName: string
Title:
Category
Maximum Length:30
Category of the attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Data type code of the attachment. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Unique identifier for the document. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The path of the folder where the attachment is stored. -
DmVersionNumber: string
Maximum Length:
255
Version number of the document 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
Error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
Error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Expiration date and time of the contents in the attachment. -
FileContents: string
(byte)
Title:
File Contents
Contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
File name of the attachment. -
FileUrl: string
Title:
File Url
URL of the attachment. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
Length of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
Name of the attachment file. -
UploadedText: string
Title:
Uploaded Text
Text of the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
URI of the attachment. -
Url: string
Title:
Url
Maximum Length:4000
URL of the attachment.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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 : checkInDocuments-questionnaireResponses-questionResponses-responseAttachments-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
Unique identifier of the attachment. It is a child of the question response. There can be zero to many attachments in a question response. -
CategoryName: string
Title:
Category
Maximum Length:30
Category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
User who created the attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
Name of the user who created the attachment. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date and time when the attachment record is created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Data type code of the attachment. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Unique identifier for the document. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The path of the folder where the attachment is stored. -
DmVersionNumber: string
Maximum Length:
255
Version number of the document 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
Error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
Error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Expiration date and time of the contents in the attachment. -
FileContents: string
(byte)
Title:
File Contents
Contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
File name of the attachment. -
FileUrl: string
Title:
File Url
URL of the attachment. -
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 and time when the attachment was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
User who last updated the attachment. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
Name of the user who last updated the attachment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
Length of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
Name of the attachment file. -
UploadedText: string
Title:
Uploaded Text
Text of the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
URI of the attachment. -
Url: string
Title:
Url
Maximum Length:4000
URL of the attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
Login associated with 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.
Examples
The following example shows how to create an attachment for question response by submitting a POST request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X POST -d <payload> http://host:port/hcmRestApi/resources/11.13.18.05/checkInDocuments/00100000000EACED00057708000110F084CF513C0000000EACED0005770800000000000000CA0000000EACED0005770800005B0A5B28FC190000000E/child/questionnaireResponses/child/<questionnaireResponseId>/child/questionResponses/<id>/child/responseAttachments
Note:
This action posts the attachments under a particular question's response.Example of Payload
The following is an example of the payload.
{ "DatatypeCode" : "FILE", "FileName" : "REST Attachment.txt", "ContentRepositoryFileShared" : "false", "Title" : "REST Attachment.txt", "Description" : "description", "FileContents" : <Base 64 encoded String of attachment> }
Example of Response Header
The following is an example of the response header.
HTTP/1.1 201 OK Content-Type : application/json
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "AttachedDocumentId": 300100172964813, "LastUpdateDate": "2018-12-03T11:31:29.440+00:00", "LastUpdatedBy": "TM-MFITZIMMONS", "DatatypeCode": "FILE", "FileName": "Hello.png", "DmFolderPath": null, "Url": null, "CategoryName": "MISC", "UserName": "Miscellaneous", "Uri": null, "FileUrl": "/content/conn/FusionAppsContentRepository/uuid/dDocID%3a26364?XFND_SCHEME_ID=1&XFND_CERT_FP=F8BDCE8D7B069AC42C45EC02FF3C6B5C482A3796&XFND_RANDOM=-116164392329630543&XFND_EXPIRES=1543840560072&XFND_SIGNATURE=FxsqohRb3505Ir0Fp7-l~oFAC8Al2~MWsmRz5hDTwHte2o8d~NEqOC4BprKfoy6FuP2pa7MzRjcIPUqW6KVKqZmhGUeqZLLBQ6fFGDMNEhiYYn3V6Qr0sa93zVhvglU1uEJIBO0yBm2W0R-irHCFt~WWr9t1W5K0ZoUYa~vepu~m6QrnazrcfcX42NOmR7Mj7J6hG-rrY2E-agqZ73hy9prEUz~MyFSAJGjr3kf37CAgPuZDNo-4Ef3D7DqlUBroZe3wCdlV4Skhn7rwfCm3BlguC6giatE0bYKt~SH9JuVxgJ5XbyMJh-JeBcNO3QguJSHUUWd~zt4GL5SPm2aRdw__&Id=26364&download", "UploadedText": null, "UploadedFileContentType": "image/png", "UploadedFileLength": 367745, "UploadedFileName": null, "ContentRepositoryFileShared": "false", "Title": "Hello Image", "Description": "Image File", "ErrorStatusCode": null, "ErrorStatusMessage": null, "CreatedBy": "TM-MFITZIMMONS", "CreationDate": "2018-12-03T11:31:29+00:00", "ExpirationDate": null, "LastUpdatedByUserName": "Meg Fitzimmons", "CreatedByUserName": "Meg Fitzimmons", "links": [ {..}] }