Contract Messages
The contract messages resource is used to view, create, update, replace, and delete messages associated with a contract.
|
Resource Plural Label |
Contract Messages |
|
Resource Name |
Message___ORACO__Contract_Message_Tgt |
Get All Contract Messages
Request: GET
URI: /crmRestApi/resources/<version>/__ORACO__CGContract_c/{id}/child/Message___ORACO__Contract_Message_Tgt
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the contract. |
Request Query Parameters
Use these finder parameters to query the resource:
| Finder Name | Description |
|---|---|
|
Primary Key |
Finds a contract message 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 Contract Message
Request: POST
URI: /crmRestApi/resources/<version>/__ORACO__CGContract_c/{id}/child/Message___ORACO__Contract_Message_Tgt
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the contract. |
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 Contract Message
Request: POST
URI: /crmRestApi/resources/<version>/__ORACO__CGContract_c/{id}/child/Message___ORACO__Contract_Message_Tgt
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the contract. |
|
Id |
integer |
The unique identifier of the contract message. |
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 Contract Message
Request: GET
URI: /crmRestApi/resources/<version>/__ORACO__CGContract_c/{id}/child/Message___ORACO__Contract_Message_Tgt/{id}
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the contract. |
|
Id |
integer |
The unique identifier of the contract message. |
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 Contract Message
Request: PATCH
URI: /crmRestApi/resources/<version>/__ORACO__CGContract_c/{id}/child/Message___ORACO__Contract_Message_Tgt/{id}
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the contract. |
|
Id |
integer |
The unique identifier of the contract message. |
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 Contract Message
Request: DELETE
URI: /crmRestApi/resources/<version>/__ORACO__CGContract_c/{id}/child/Message___ORACO__Contract_Message_Tgt/{id}
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the contract. |
|
Id |
integer |
The unique identifier of the contract message. |
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 |
|
LOVVA_For___ORACO__MessageType_c |
LookupCode |
__ORACO__MessageType_c |
Resource Attributes
This table lists all the attributes of the resource.
| Attribute Name | Attribute Type | Description |
|---|---|---|
|
Id |
number |
The unique identifier of the message. UI Label: Record ID |
|
RecordName |
string |
The name of the message. Properties: The maximum length is 80. UI Label: Name |
|
CreatedBy |
string |
The user who created the message. Properties: The maximum length is 32. UI Label: Created By |
|
CreationDate |
datetime |
The date when the message was created. UI Label: Creation Date |
|
LastUpdatedBy |
string |
The user who last updated the message. Properties: The maximum length is 32. UI Label: Last Updated By |
|
LastUpdateDate |
datetime |
The date when the message was last updated. UI Label: Last Update Date |
|
RecordNumber |
string |
The alternate key identifier of the message. Properties: The maximum length is 64. UI Label: Record Number |
|
LastUpdateLogin |
string |
The login of the user who last updated the message. 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 message. 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. 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 associated with the message. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. Properties: The maximum length is 15. |
|
__ORACO__OraZcxOwner_Id_c |
number |
The unique identifier of the resource. UI Label: Owner |
|
__ORACO__OraZcxOwner_c |
string |
The name of the resource. Properties: The maximum length is 1500. UI Label: Owner |
|
__ORACO__MessageText_c |
string |
The actual text of the message. Properties: The maximum length is 200. UI Label: Message Text |
|
__ORACO__SelectedRow |
string |
A field used for internal logic. UI Label: SelectedRow |
|
Activity_Id___ORACO__Activity_Message |
integer |
UI Label: Activity ID __ORACO__Activity_Message |
|
ShoppingCartDSD_Id___ORACO__ShoppingCart_Message |
integer |
UI Label: ShoppingCartDSD ID __ORACO__ShoppingCart_Message |
|
OrderDSD_Id___ORACO__OrderRequest_Message |
integer |
UI Label: OrderDSD ID __ORACO__OrderRequest_Message |
|
PaymentDSD_Id___ORACO__Payment_Message |
integer |
UI Label: PaymentDSD ID __ORACO__Payment_Message |
|
__ORACO__MessageType_c |
string |
The type of the message. Properties: The maximum length is 1500. UI Label: Message Type |
|
CGContract_Id___ORACO__Contract_Message |
integer |
Contract message UI Label: CGContract ID __ORACO__Contract_Message |