Documents
Subcategories: Attachments, Notes
The document resource is used to view, create, and update documents.
|
Resource Plural Label |
Documents |
|
Resource Name |
__ORACO__Document_c |
Get all Documents
Request: GET
URI: /crmRestApi/resources/11.13.18.05/__ORACO__Document_c
Request Path Parameters
There are no request path parameters for this task.
Request Query Parameters
Use these finder parameters to query the resource:
| Finder Name | Description |
|---|---|
|
Primary Key |
Finds a Document with 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 |
Create a Document
Request: POST
URI: /crmRestApi/resources/11.13.18.05/__ORACO__Document_c
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 a Document
Request: GET
URI: /crmRestApi/resources/11.13.18.05/__ORACO__Document_c/{Id}
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the Document. |
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 a Document
Request: PATCH
URI: /crmRestApi/resources/11.13.18.05/__ORACO__Document_c/{Id}
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the Document. |
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 |
Replace a Document
Request: PUT
URI: /crmRestApi/resources/11.13.18.05/__ORACO__Document_c/{Id}
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the Document. |
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 Document
Request: DELETE
URI: /crmRestApi/resources/11.13.18.05/__ORACO__Document_c/{Id}
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the Document. |
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
This table lists all the list of values of the resource.
| LOV Name | Source Attribute in LOV | Target Attribute in Resource |
|---|---|---|
|
ViewAccessor_CurrencyCode |
CurrencyCode |
CurrencyCode |
|
FK_LOVVA_For___ORACO__PresettleRprtNum_c |
Id |
__ORACO__PresettleRprtNum_Id_c |
|
LOVVA_For___ORACO__PresettleRprtNum_c |
RecordName |
__ORACO__PresettleRprtNum_c |
|
FK_LOVVA_For___ORACO__Account_c |
OrganizationProfileId |
__ORACO__Account_Id_c |
|
LOVVA_For___ORACO__Account_c |
OrganizationName |
__ORACO__Account_c |
|
LOVVA_For___ORACO__DocumentType_c |
LookupCode |
__ORACO__DocumentType_c |
|
LOVVA_For___ORACO__Available_c |
LookupCode |
__ORACO__Available_c |
|
LOVVA_For___ORACO__ReasonForNotAvailable_c |
LookupCode |
__ORACO__ReasonForNotAvailable_c |
Resource Attributes
This table lists all the attributes of the resource.
| Attribute Name | Attribute Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the document. UI Label: Record ID |
|
RowType |
string |
The type of the document. Properties: The maximum length is 80. |
|
RecordName |
string |
The name of the document. Properties: The maximum length is 80. UI Label: Document Id |
|
CreatedBy |
string |
The user who created the document. Properties: The maximum length is 32. UI Label: Created By |
|
CreationDate |
datetime |
The date when the document was created. UI Label: Creation Date |
|
LastUpdatedBy |
string |
The user who last updated the document. Properties: The maximum length is 32. UI Label: Last Updated By |
|
LastUpdateDate |
datetime |
The date when the document was last updated. UI Label: Last Update Date |
|
LastUpdateLogin |
string |
The login of the user who last updated the document. Properties: The maximum length is 32. |
|
UserLastUpdateDate |
datetime |
The date and time of the last user update made from a personal device. This value is different from LAST_UPDATE_DATE if the record was originally updated in a different database (a different mobile database or the server). |
|
CurrencyCode |
string |
The currency code associated with the document. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. Properties: The maximum length is 15. UI Label: Currency Code |
|
CurcyConvRateType |
string |
The currency conversion rate type associated with the document. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. Properties: The maximum length is 15. |
|
CorpCurrencyCode |
string |
The corporate currency code of the document. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. Properties: The maximum length is 15. |
|
SourceType |
string |
The type of the source object such as, Opportunities or Partners, as defined in the object metadata. Properties: The maximum length is 0. |
|
__ORACO__Amount_c |
number |
The amount collected for the document. UI Label: Amount |
|
__ORACO__PresettleRprtNum_Id_c |
integer |
The unique identifier of the presettlement report. UI Label: Presettlement Report Number |
|
__ORACO__PresettleRprtNum_c |
string |
The name of the presettlement report. Properties: The maximum length is 1500. UI Label: Presettlement Report Number |
|
__ORACO__Account_Id_c |
integer |
The unique identifier of the account for which the documents are submitted. UI Label: Account |
|
__ORACO__Account_c |
string |
The name of the account for which the documents are submitted. Properties: The maximum length is 1500. UI Label: Account |
|
__ORACO__DocumentType_c |
string |
The document type of the selected document. Properties: The maximum length is 1500. UI Label: Document Type |
|
__ORACO__Available_c |
string |
The document availability. The values can be either Yes or No. Properties: The maximum length is 1500. UI Label: Available |
|
__ORACO__ReasonForNotAvailable_c |
string |
The reason why a document is missing. Properties: The maximum length is 1500. UI Label: Reason for not available |
|
__ORACO__AuxiliaryAttribute01_c |
string |
Additional internal fields for development usage. Properties: The maximum length is 80. UI Label: Auxiliary Attribute 01 |
|
__ORACO__AuxiliaryAttribute02_c |
string |
Additional internal fields for development usage. Properties: The maximum length is 80. UI Label: Auxiliary Attribute 02 |
|
__ORACO__AuxiliaryAttribute03_c |
string |
Additional internal fields for development usage. Properties: The maximum length is 80. UI Label: Auxiliary Attribute 03 |
|
__ORACO__AuxiliaryAttribute04_c |
string |
Additional internal fields for development usage. Properties: The maximum length is 80. UI Label: Auxiliary Attribute 04 |
|
__ORACO__AuxiliaryAttribute05_c |
string |
Additional internal fields for development usage. Properties: The maximum length is 80. UI Label: Auxiliary Attribute 05 |
|
__ORACO__AuxiliaryAttribute06_c |
integer |
Additional internal fields for development usage. UI Label: Auxiliary Attribute 06 |
|
__ORACO__AuxiliaryAttribute07_c |
integer |
Additional internal fields for development usage. UI Label: Auxiliary Attribute 07 |
|
__ORACO__AuxiliaryAttribute08_c |
integer |
Additional internal fields for development usage. UI Label: Auxiliary Attribute 08 |
|
__ORACO__AuxiliaryAttribute09_c |
integer |
Additional internal fields for development usage. UI Label: Auxiliary Attribute 09 |
|
__ORACO__AuxiliaryAttribute10_c |
integer |
Additional internal fields for development usage. UI Label: Auxiliary Attribute 10 |
|
__ORACO__AuxiliaryAttribute11_c |
date |
Additional internal fields for development usage. UI Label: Auxiliary Attribute 11 |
|
__ORACO__AuxiliaryAttribute12_c |
date |
Additional internal fields for development usage. UI Label: Auxiliary Attribute 12 |
|
__ORACO__AuxiliaryAttribute13_c |
datetime |
Additional internal fields for development usage. UI Label: Auxiliary Attribute 13 |
|
__ORACO__AuxiliaryAttribute14_c |
datetime |
Additional internal fields for development usage. UI Label: Auxiliary Attribute 14 |
|
__ORACO__DocumentNumber_c |
string |
The number of the document. Properties: The maximum length is 80. UI Label: Document Number |