Attachments
The attachments resource is used to view, create, update, and delete attachments of a condition compliance history. An attachment includes additional information about a condition compliance history.
|
Resource Plural Label |
Attachments |
|
Resource Name |
Attachment |
Get All Attachments
Request: GET
URI: /crmRestApi/resources/11.13.18.05/__ORACO__ConditionComplHist_c/{id}/child/Attachment
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the condition compliance history. |
Request Query Parameters
Use these finder parameters to query the resource:
| Finder Name | Description |
|---|---|
|
Primary Key |
Finds an attachment wit the specified primary key. Finder Variables:
|
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 |
Upload an Attachment
Request: POST
URI: /crmRestApi/resources/11.13.18.05/__ORACO__ConditionComplHist_c/{id}/child/Attachment
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the condition compliance history. |
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 |
Replace an Attachment
Request: POST
URI: /crmRestApi/resources/11.13.18.05/__ORACO__ConditionComplHist_c/{Id}/child/Attachment/{AttachedDocumentId}
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the condition compliance history. |
|
AttachedDocumentId |
integer |
The unique identifier of the attachment. |
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 Attachment
Request: GET
URI: /crmRestApi/resources/11.13.18.05/__ORACO__ConditionComplHist_c/{Id}/child/Attachment/{AttachedDocumentId}
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the condition compliance history. |
|
AttachedDocumentId |
integer |
The unique identifier of the attachment. |
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 Attachment
Request: PATCH
URI: /crmRestApi/resources/11.13.18.05/__ORACO__ConditionComplHist_c/{Id}/child/Attachment/{AttachedDocumentId}
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the condition compliance history. |
|
AttachedDocumentId |
integer |
The unique identifier of the attachment. |
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 |
Remove an Attachment
Request: DELETE
URI: /crmRestApi/resources/11.13.18.05/__ORACO__ConditionComplHist_c/{Id}/child/Attachment/{AttachedDocumentId}
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the condition compliance history. |
|
AttachedDocumentId |
integer |
The unique identifier of the attachment. |
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 attachment. UI Label: Attached Document Id |
|
LastUpdateDate |
datetime |
The date when the attachment was last updated. UI Label: Last Update Date |
|
LastUpdatedBy |
string |
The user who last updated the attachment. Properties: The maximum length is 255. UI Label: Last Updated By |
|
DatatypeCode |
string |
The value that indicates the data type code of the attachment. 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. UI Label: Dm Folder Path |
|
Url |
string |
The URL of the 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 associated with the attachment. Properties: The maximum length is 255. UI Label: User Name |
|
Uri |
string |
The URI of the attachment. Properties: The maximum length is 4000. UI Label: Uri |
|
FileUrl |
string |
The URL of the attachment file. UI Label: File Url |
|
UploadedText |
string |
The text of the attachment. UI Label: Uploaded Text |
|
UploadedFileContentType |
string |
The content type of the attachment. UI Label: Uploaded File Content Type |
|
UploadedFileLength |
integer |
The length of the attachment file. UI Label: File Size |
|
UploadedFileName |
string |
The name of the attachment file. UI Label: Uploaded File Name |
|
ContentRepositoryFileShared |
boolean |
Indicates whether the attachment is shared. If True then 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 attachment. Properties: The maximum length is 255. UI Label: Created By |
|
CreationDate |
datetime |
The date when the attachment 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 login of the user who last updated the attachment. UI Label: Last Updated By User |
|
CreatedByUserName |
string |
The login of the user who created the attachment. UI Label: Created By User Name |