Terms
Subcategories: Attachments, Notes
The terms resource is used to view, create, update, replace, and delete the terms.
|
Resource Plural Label |
Terms |
|
Resource Name |
__ORACO__Term_c |
Get All Terms
Request: GET
URI: /crmRestApi/resources/11.13.18.05/__ORACO__Term_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 term 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 Term
Request: POST
URI: /crmRestApi/resources/11.13.18.05/__ORACO__Term_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 |
Replace a Term
Request: POST
URI: /crmRestApi/resources/11.13.18.05/__ORACO__Term_c/{Id}
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the term. |
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 Term
Request: GET
URI: /crmRestApi/resources/11.13.18.05/__ORACO__Term_c/{Id}
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the term. |
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 Term
Request: PATCH
URI: /crmRestApi/resources/11.13.18.05/__ORACO__Term_c/{Id}
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the term. |
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 Term
Request: DELETE
URI: /crmRestApi/resources/11.13.18.05/__ORACO__Term_c/{Id}
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the term. |
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__OraZcxOwner_c |
ResourceProfileId |
__ORACO__OraZcxOwner_Id_c |
|
LOVVA_For___ORACO__OraZcxOwner_c |
PartyName |
__ORACO__OraZcxOwner_c |
|
FK_LOVVA_For___ORACO__ContractTemplate_c |
Id |
__ORACO__ContractTemplate_Id_c |
|
LOVVA_For___ORACO__ContractTemplate_c |
RecordName |
__ORACO__ContractTemplate_c |
|
LOVVA_For___ORACO__Required_c |
value |
__ORACO__Required_c |
|
LOVVA_For___ORACO__Negotiable_c |
value |
__ORACO__Negotiable_c |
|
FK_LOVVA_For___ORACO__Contract_c |
Id |
__ORACO__Contract_Id_c |
|
LOVVA_For___ORACO__Contract_c |
RecordName |
__ORACO__Contract_c |
Resource Attributes
This table lists all the attributes of the resource.
| Attribute Name | Attribute Type | Description |
|---|---|---|
|
Id |
number |
The unique identifier of the term. UI Label: ID |
|
RecordName |
string |
The name of the term. Properties: The maximum length is 80. UI Label: Name |
|
CreatedBy |
string |
The user who created the term. Properties: The maximum length is 32. UI Label: Created By |
|
CreationDate |
datetime |
The date when the term was created. UI Label: Creation Date |
|
LastUpdatedBy |
string |
The user who last updated the term. Properties: The maximum length is 32. UI Label: Last Updated By |
|
LastUpdateDate |
datetime |
The date when the term was last updated. UI Label: Last Update Date |
|
RecordNumber |
string |
The alternate key identifier of the term. This attribute is used for internal logics. Properties: The maximum length is 64. UI Label: Record Number |
|
LastUpdateLogin |
string |
The login details of the user who last updated the term. 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 term. 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 term. 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 term. 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. |
|
__ORACO__OraZcxOwner_Id_c |
number |
The unique identifier of the owner of the record. UI Label: Owner |
|
__ORACO__OraZcxOwner_c |
string |
The name of the owner of the record. Properties: The maximum length is 1500. UI Label: Owner |
|
__ORACO__ParentTemplate_c |
string |
The name of the parent contract template reference. Properties: The maximum length is 80. UI Label: Parent Contract Template |
|
__ORACO__ContractTemplate_Id_c |
number |
The unique identifier of the contract template. UI Label: Contract Template |
|
__ORACO__ContractTemplate_c |
string |
The name of the contract template. Properties: The maximum length is 1500. UI Label: Contract Template |
|
__ORACO__Required_c |
boolean |
Indicates whether the term is required. Properties: The maximum length is 10. UI Label: Required |
|
__ORACO__Negotiable_c |
boolean |
Indicates whether the term is negotiable. Properties: The maximum length is 10. UI Label: Negotiable |
|
__ORACO__RawContent_c |
attachment |
The store the raw content of the Terms which will have Contract related fields embedded Properties: The maximum length is 32714. UI Label: Description |
|
__ORACO__ProcessedContent_c |
attachment |
This field will have the resolved text of raw content, raw content will have Contract fields which will be replaced with corresponding values in the processed content Properties: The maximum length is 32714. UI Label: Expanded Description |
|
__ORACO__Contract_Id_c |
number |
The unique identifier of the contract for which term is created. UI Label: Contract |
|
__ORACO__Contract_c |
string |
The name of the contract for which term is created. Properties: The maximum length is 1500. UI Label: Contract |
|
__ORACO__SelectedRow |
string |
A field used for internal logic. UI Label: SelectedRow |