Activities Attachments
Subcategories:
The attachment resource is used to view, create, and update attachments of an account. An attachment includes additional information about an account.
|
Resource Plural Label |
Activity Attachments |
|
Resource Name |
Attachments |
Get all Activities Attachments
Request: GET
URI:
/crmRestApi/resources/<version>/activities/{ActivityNumber}/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 an Activities Attachment
Request: POST
URI:
/crmRestApi/resources/<version>/activities/{ActivityNumber}/child/Attachment
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 |
Get an Activities Attachment
Request: GET
URI:
/crmRestApi/resources/<version>/activities/{ActivityNumber}/child/Attachment/{AttachmentId}
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
This table summarizes the supported response body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Update an Activities Attachment
Request: PATCH
URI:
/crmRestApi/resources/<version>/activities/{ActivityNumber}/child/Attachment/{AttachmentId}
Request Path Parameters
There are no request path parameters for this task.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 an Activities Attachment
Request: DELETE
URI:
/crmRestApi/resources/<version>/activities/{ActivityNumber}/child/Attachment/{AttachmentId}
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.
Replace an Activities Attachment
Request: PUT
URI:
/crmRestApi/resources/<version>/activities/{ActivityNumber}/child/Attachment/{AttachmentId}
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 |
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 |
|---|---|---|
|
LastUpdateDate |
string |
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 |
|
EntityName |
string |
A system-generated read-only attribute used by the application framework. Properties: The maximum length is 40. |
|
Pk1Value |
string |
The identifier of the attachment document as stored by external system. Properties: The maximum length is 150. |
|
Pk2Value |
string |
The identifier of the attachment document as stored by external system. Properties: The maximum length is 150. |
|
Pk3Value |
string |
The identifier of the attachment document as stored by external system. Properties: The maximum length is 150. |
|
Pk4Value |
string |
The identifier of the attachment document as stored by external system. Properties: The maximum length is 150. |
|
Pk5Value |
string |
The identifier of the attachment document as stored by external system. Properties: The maximum length is 150. |
|
DatatypeCode |
string |
The code indicating the type of the data in the attachment. For example, FILE, WEB_PAGE, or TEXT. 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 of the attachment. Properties: The maximum length is 1000. |
|
DmDocumentId |
string |
The unique identifier of the attached document. Properties: The maximum length is 255. |
|
DmVersionNumber |
string |
The current version number of the attachment. Properties: The maximum length is 255. |
|
Url |
string |
The URL of the attachment. Properties: The maximum length is 4000. |
|
CategoryName |
string |
The name of the category of the attachment. Properties: The maximum length is 30. UI Label: Category |
|
UserName |
string |
The login associated with the attachment. Properties: The maximum length is 255. |
|
Uri |
string |
The URI of the attachment. Properties: The maximum length is 4000. |
|
EntAppShortName |
string |
The enterprise application short name of the attachment. Properties: The maximum length is 80. |
|
FileUrl |
string |
The URL of the attachment. Properties: The maximum length is 0. |
|
UploadedText |
string |
The text of the attachment. Properties: The maximum length is 0. |
|
UploadedFileContentType |
string |
The content type of the attachment. Properties: The maximum length is 0. |
|
UploadedFileLength |
integer |
The length of the attachment file. |
|
UploadedFileName |
string |
The name of the attachment file. Properties: The maximum length is 0. |
|
ContentRepositoryFileShared |
boolean |
Indicates whether the attachment is shared. The default value is false. Properties: The maximum length is 0. UI Label: Shared |
|
Title |
string |
The title of the attachment. Properties: The maximum length is 0. UI Label: Title |
|
Description |
string |
The description of the attachment. Properties: The maximum length is 255. UI Label: Description |
|
ErrorStatusCode |
string |
The code indicating the type of error, if any, for the attachment. Properties: The maximum length is 0. |
|
ErrorStatusMessage |
string |
The error message, if any, for the attachment. Properties: The maximum length is 0. |
|
CreatedBy |
string |
The user who created the attachment. |
|
CreationDate |
string |
The date when the attachment record was created. |
|
FileContents |
attachment |
The contents of the attachment. |
|
ExpirationDate |
string |
The date when the contents in the attachment expire. |
|
AttachedDocumentId |
integer |
The unique identifier of the attached document. UI Label: Attached Document ID |
|
CreatedByUserName |
string |
The user name of the person who uploaded the image. |
|
LastUpdatedByUserName |
string |
The user name of the person who last updated the image. |
|
AsyncTrackerId |
string |
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. UI Label: Asynchronous Upload Tracker Id |