Attainment Targets
Subcategories: Attachments, Notes
The target attainments resource is defined for either a Benefit or a Condition (within a Contract).
|
Resource Plural Label |
Attainment Targets |
|
Resource Name |
__ORACO__AttainmentTarget_c |
Get All Attainment Targets
Request: GET
URI: /crmRestApi/resources/11.13.18.05/__ORACO__AttainmentTarget_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 an attainment target 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 an Attainment Target
Request: POST
URI: /crmRestApi/resources/11.13.18.05/__ORACO__AttainmentTarget_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 an Attainment Target
Request: POST
URI: /crmRestApi/resources/11.13.18.05/__ORACO__AttainmentTarget_c/{Id}
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the attainment target. |
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 Attainment Target
Request: GET
URI: /crmRestApi/resources/11.13.18.05/__ORACO__AttainmentTarget_c/{Id}
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the attainment target. |
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 Attainment Target
Request: PATCH
URI: /crmRestApi/resources/11.13.18.05/__ORACO__AttainmentTarget_c/{Id}
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the attainment target. |
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 Attainment Target
Request: DELETE
URI: /crmRestApi/resources/11.13.18.05/__ORACO__AttainmentTarget_c/{Id}
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the attainment target. |
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__Account_c |
OrganizationProfileId |
__ORACO__Account_Id_c |
|
LOVVA_For___ORACO__Account_c |
OrganizationName |
__ORACO__Account_c |
|
FK_LOVVA_For___ORACO__Product_c |
InventoryItemId |
__ORACO__Product_Id_c |
|
LOVVA_For___ORACO__Product_c |
Name |
__ORACO__Product_c |
Resource Attributes
This table lists all the attributes of the resource.
| Attribute Name | Attribute Type | Description |
|---|---|---|
|
Id |
number |
The unique identifier of the attainment target. UI Label: Record ID |
|
RecordName |
string |
The name of the attainment target. Properties: The maximum length is 80. UI Label: Attainment Name |
|
CreatedBy |
string |
The user who created the attainment target. Properties: The maximum length is 32. UI Label: Created By |
|
CreationDate |
datetime |
The date when the attainment target was created. UI Label: Creation Date |
|
LastUpdatedBy |
string |
The user who last updated the attainment target. Properties: The maximum length is 32. UI Label: Last Updated By |
|
LastUpdateDate |
datetime |
The date when the attainment target was last updated. UI Label: Last Update Date |
|
RecordNumber |
string |
The alternate key identifier of the record. This attribute is used for internal logics. Properties: The maximum length is 64. UI Label: Record Number |
|
LastUpdateLogin |
string |
The login of the user who last updated the attainment target. 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 audit. 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 audit. 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 audit. 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__Account_Id_c |
number |
The unique identifier of the account associated with the attainment target. UI Label: Account |
|
__ORACO__Account_c |
string |
The name of the account associated with the attainment target. Properties: The maximum length is 1500. UI Label: Account |
|
__ORACO__Product_Id_c |
number |
The unique identifier of the product for which the attainment target was created. UI Label: Product |
|
__ORACO__Product_c |
string |
The name of the product for which the attainment target was created. Properties: The maximum length is 1500. UI Label: Product |
|
__ORACO__Attainment_c |
number |
The value that was attained. UI Label: Attainment |
|
__ORACO__DistributionIndex_c |
integer |
The index of the distribution schedule for which the attainment target was created. UI Label: Distribution Index |
|
__ORACO__SelectedRow |
string |
A field used for internal logic. UI Label: SelectedRow |
|
Benefit_Id___ORACO__BenefitAttainment |
integer |
The unique identifier of the benefit for which the attainment target was created. UI Label: Benefit ID __ORACO__BenefitAttainment |
|
Condition_Id___ORACO__ConditionAttainments |
integer |
The unique identifier of the condition for which the attainment target was created. UI Label: Condition ID __ORACO__ConditionAttainments |