Attachments
Subcategories:
The attachment resource is used to view, create, and update attachments of a survey answer task. An attachment includes additional information about a survey answer task.
|
Resource Plural Label |
Attachments |
|
Resource Name |
Attachment |
Get all Survey Answer Attachments
Request: GET
URI:
/crmRestApi/resources/<version>/__ORACO__SurAnswer_c/{id}/child/Attachment
Request Path Parameters
There are no request path parameters for this task.
Request Query Parameters
There are no request query parameters for this task.Request Body
There are no elements in the request body for this task.
Response Body
This table summarizes the supported response body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Create a Survey Answer Attachment
Request:POST
URI:/crmRestApi/resources/<version>/__ORACO__SurAnswer_c/{id}/child/Attachment
Request Path Parameters
There are no request path parameters for this task.
Sample Request
{
"__ORACO__Answer_c": "PEltYWdlX1NlbGVjdGVkPg==",
"__ORACO__Question_c": "cGhvdG8gcXVlc3Rpb24gMg==",
"__ORACO__SurveyQuestion_Id_c": 300100543086201,
"__ORACO__Survey_Id_c" : 300100543090189
}
Request Body
This table summarizes the supported request body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Response Body
This table summarizes the supported response body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Get a Survey Answer Attachment
Request: GET
URI:
/crmRestApi/resources/<version>/__ORACO__SurAnswer_c/{Id}/child/Attachment/{Id}
Request Path Parameters
There are no request path parameters for this task.
Request Body
This table summarizes the supported request body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Response Body
This table summarizes the supported response body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Update a Survey Answer Attachment
Request: PATCH
URI:
/crmRestApi/resources/<version>/__ORACO__SurAnswer_c/{Id}/child/Attachment/{Id}
Request Path Parameters
There are no request path parameters for this task.
Request Body
There are no elements in the request body for this task.
Sample Request
{
"__ORACO__Answer_c": "PEltYWdlX1NlbGVjdGVkPg==",
"__ORACO__Question_c": "cGhvdG8gcXVlc3Rpb24gMg==",
"__ORACO__Survey_Id_c" : 300100543090192
}
Response Body
This table summarizes the supported response body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Replace a Survey Answer Attachment
Request: PUT
URI:
/crmRestApi/resources/<version>/__ORACO__SurAnswer_c/{Id}/child/Attachment/{Id}
Request Path Parameters
There are no request path parameters for this task.
Sample Request
{
"__ORACO__Answer_c": "PEltYWdlX1NlbGVjdGVkPg==",
"__ORACO__Question_c": "cGhvdG8gcXVlc3Rpb24gMg==",
"__ORACO__SurveyQuestion_Id_c": 300100543086285,
}
Request Body
This table summarizes the request body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Response Body
This table summarizes the supported response body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Delete a Survey Answer Attachment
Request: DELETE
URI:
/crmRestApi/resources/<version>/__ORACO__SurAnswer_c/{Id}/child/Attachment/{Id}
Request Path Parameters
There are no request path parameters for this task.
Request Body
There are no elements in the request body for this task.
Response Body
There are no elements in the response body for this task.
List of Values
There are no LOVs for this resource.
Resource Attributes
This table lists all the attributes of the resource.
| Attribute Name | Attribute Type | Description |
|---|---|---|
|
AttachedDocumentId |
integer |
The unique identifier of the attached document. UI Label: Attached Document Id |
|
LastUpdateDate |
datetime |
The date when the record was last updated. UI Label: Last Update Date |
|
LastUpdatedBy |
string |
The user who last updated the record. Properties: The maximum length is 255. UI Label: Last Updated By |
|
DatatypeCode |
string |
A value that indicates the data type. Properties: The maximum length is 30. UI Label: Type |
|
FileName |
string |
The file name of the attachment. Properties: The maximum length is 2048. UI Label: File Name |
|
DmFolderPath |
string |
The folder path from which the attachment is created. Properties: The maximum length is 1000. UI Label: Dm Folder Path |
|
DmDocumentId |
string |
The document ID from which the attachment is created. Properties: The maximum length is 255. |
|
DmVersionNumber |
string |
The document version number from which the attachment is created. Properties: The maximum length is 255. |
|
Url |
string |
The URL of a web page type attachment. Properties: The maximum length is 4000. UI Label: Url |
|
CategoryName |
string |
The category of the attachment. Properties: The maximum length is 30. UI Label: Category |
|
UserName |
string |
The login credentials of the user who created the attachment. Properties: The maximum length is 255. UI Label: User Name |
|
Uri |
string |
The URI of a Topology Manager type attachment. Properties: The maximum length is 4000. UI Label: Uri |
|
FileUrl |
string |
The URI of the file. UI Label: File Url |
|
UploadedText |
string |
The text content for a new text attachment. UI Label: Uploaded Text |
|
UploadedFileContentType |
string |
The content type of the attachment. UI Label: Uploaded File Content Type |
|
UploadedFileLength |
integer |
The size of the attachment file. UI Label: File Size |
|
UploadedFileName |
string |
The name to assign to a new attachment file. UI Label: Uploaded File Name |
|
ContentRepositoryFileShared |
boolean |
Indicates whether the attachment is shared UI Label: Shared |
|
Title |
string |
The title of the attachment. UI Label: Title |
|
Description |
string |
The description of the attachment. Properties: The maximum length is 255. UI Label: Description |
|
ErrorStatusCode |
string |
The error code, if any, for the attachment. UI Label: Error Status Code |
|
ErrorStatusMessage |
string |
The error message, if any, for the attachment. UI Label: Error Status Message |
|
CreatedBy |
string |
The user who created the record. Properties: The maximum length is 255. UI Label: Created By |
|
CreationDate |
datetime |
The date when the record was created. UI Label: Creation Date |
|
FileContents |
attachment |
The contents of the attachment. UI Label: File Contents |
|
ExpirationDate |
datetime |
The expiration date of the contents in the attachment. UI Label: Expiration Date |
|
LastUpdatedByUserName |
string |
The user name who last updated the record. UI Label: Last Updated By User |
|
CreatedByUserName |
string |
The user name who created the record. UI Label: Created By User Name |
|
AsyncTrackerId |
string |
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. UI Label: Asynchronous Upload Tracker Id |
|
FileWebImage |
attachment |
The base64 encoded image of the file displayed in .png format if the source is a convertible image. UI Label: File Web Image |