Promotion Programs
Subcategories: Promotion Groups Collection, Promotion Product Collection, Attachments, Notes.
The promotion program resource is used to view, create, or update promotion programs. A promotion program is a promotion template for creating account-specific promotions.
|
Resource Plural Label |
Promotion Programs |
|
Resource Name |
__ORACO__PromotionProgram_c |
Get All Promotion Programs
Request: GET
URI: /crmRestApi/resources/11.13.18.05/__ORACO__PromotionProgram_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 promotion program 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 Promotion Program
Request: POST
URI: /crmRestApi/resources/11.13.18.05/__ORACO__PromotionProgram_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 Promotion Program
Request: GET
URI: /crmRestApi/resources/11.13.18.05/__ORACO__PromotionProgram_c/{id}
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
| Id | integer | The unique identifier of the promotion program. |
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 Promotion Program
Request: PATCH
URI: /crmRestApi/resources/11.13.18.05/__ORACO__PromotionProgram_c/{id}
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
| Id | integer | The unique identifier of the promotion program. |
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 Promotion Program
Request: PUT
URI: /crmRestApi/resources/11.13.18.05/__ORACO__PromotionProgram_c/{id}
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
| Id | integer | The unique identifier of the promotion program. |
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 Promotion Program
Request: DELETE
URI: /crmRestApi/resources/11.13.18.05/__ORACO__PromotionProgram_c/{id}
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
| Id | integer | The unique identifier of the promotion program. |
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 |
|
LOVVA_For___ORACO__Status_c |
LookupCode |
__ORACO__Status_c |
Resource Attributes
This table lists all the attributes of the resource.
| Attribute Name | Attribute Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the promotion program. UI Label: Record ID |
|
RowType |
string |
The type field for the categorization of the records. Properties: The maximum length is 80. |
|
RecordName |
string |
The name of the promotion program. Properties: The maximum length is 80. UI Label: Name |
|
CreatedBy |
string |
The user who created the promotion program. Properties: The maximum length is 32. UI Label: Created By |
|
CreationDate |
datetime |
The date when the promotion program was created. UI Label: Creation Date |
|
LastUpdatedBy |
string |
The user who last updated the promotion program. Properties: The maximum length is 32. UI Label: Last Updated By |
|
LastUpdateDate |
datetime |
The date when the promotion program was last updated. UI Label: Last Update Date |
|
LastUpdateLogin |
string |
The login of the user who last updated the promotion program. Properties: The maximum length is 32. |
|
CpdrfVerSor |
integer |
The Cross Pillar Data Replication Framework (CADRE) system column for tracking record version in the System of Record (SOAR) pillar when a record change is replicated to subscribing pillars by the replication flows. It is a system-generated read-only attribute used by the application framework. |
|
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 (That is, a different mobile database or the server). |
|
CpdrfLastUpd |
string |
The Cross Pillar Data Replication Framework (CPDRF) system column for tracking the source pillar name when a record is changed by the replication flows. Properties: The maximum length is 15. |
|
CpdrfVerPillar |
integer |
The Cross Pillar Data Replication Framework (CPDRF) system column for tracking the record version when a record is changed by replication flows |
|
JobDefinitionPackage |
string |
The name of the package running the job that created or last updated the row. Properties: The maximum length is 900. |
|
RequestId |
integer |
The unique identifier of the job request that created or last updated the row. |
|
JobDefinitionName |
string |
The name of the job request that created or last updated the row. Properties: The maximum length is 100. |
|
CurrencyCode |
string |
The currency code. 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 |
|
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 assortment. 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. |
|
SourceType |
string |
The type of the source object as defined in the object metadata. |
|
AttachmentEntityName |
string |
The name of the object or table that is associated with the attachments of this object. |
|
PKProxy |
string |
A system-generated read-only attribute used by the application framework. Properties: The maximum length is 18. |
|
IsOwner |
string |
A system-generated read-only attribute used by the application framework. |
|
__ORACO__Advertising_c |
number |
The budget allocated for advertising. UI Label:
|
|
__ORACO__Catalog_c |
number |
The budget allocated for catalogs. UI Label: Catalog |
|
__ORACO__Merchandising_c |
number |
The budget allocated for merchandising. UI Label: Merchandising |
|
__ORACO__Space_c |
number |
The budget allocated for storage space. UI Label: Space |
|
__ORACO__Description_c |
string |
The description of the promotion program. Properties: The maximum length is 1000. UI Label: Description |
|
__ORACO__EndDate_c |
date |
The date when the promotion program ends. UI Label: End Date |
|
__ORACO__StartDate_c |
date |
The date when the promotion program begins. UI Label: Start Date |
|
__ORACO__Status_c |
string |
The status of the promotion program. Properties: The maximum length is 1500. UI Label: Status |
|
Extn__ORACO__PromotionProgram _cFuseDetailLayout5Expr |
string |
The expression for the layout. |
|
Extn__ORACO__PromotionProgram _cFuseDetailLayout6Expr |
string |
The expression for the layout. |