Create a strategy assignment
post
/fscmRestApi/resources/11.13.18.05/collectionStrategies
Request
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AccountNumber: string
Title:
Account Number
Maximum Length:30
The customer account to which the strategy is assigned. -
BusinessUnit: string
Title:
Business Unit
Maximum Length:240
The business unit under which the strategy assignment is created. -
ChangeStrategy: string
The change strategy attribute is used to override the existing strategy with a new strategy. This is an optional attribute. The valid value is Y.
-
NextStrategyTask: string
Title:
Next Strategy Task
Maximum Length:255
The next strategy task of the strategy assignment. When the strategy execution tasks are created, the value of Next Strategy Task is set to the open strategy task. -
PartyNumber: string
Title:
Party Number
Maximum Length:30
The unique identification number of the customer to which the strategy is assigned. This is a mandatory attribute. -
Score: number
Title:
Score
The score of the customer, account, or site used for the strategy assignment. -
SiteUse: string
Title:
Site
Maximum Length:150
The customer site to which the strategy is assigned. -
strategyExecutionTasks: array
Tasks
Title:
Tasks
The tasks resource is used to create, update, or view strategy tasks assigned to customers, customer accounts, or sites, depending on the customers' business levels. These strategy tasks can be executed or non-executed when they are predefined based on strategy group setup, or executed ad hoc, user-defined tasks. -
StrategyId: integer
(int64)
Title:
Strategy ID
The unique identifier of the strategy assignment. -
StrategyStatus: string
Title:
Strategy Status
Maximum Length:255
The status of the strategy assignment. -
StrategyTemplate: string
Title:
Strategy Template
Maximum Length:240
The strategy template used for the strategy assignment. This is a mandatory attribute. -
strategyTemplateTasks: array
Strategy Template Tasks
Title:
Strategy Template Tasks
A strategy template task resource is used to retrieve all future tasks that are defined from the strategy setup template and skipped template tasks. -
strategyUserTasks: array
User Tasks
Title:
User Tasks
The user tasks resource is used to create, update, or view any ad hoc strategy tasks that collectors want to add to the list of predefined strategy tasks for a particular strategy assignment.
Nested Schema : Tasks
Type:
array
Title:
Tasks
The tasks resource is used to create, update, or view strategy tasks assigned to customers, customer accounts, or sites, depending on the customers' business levels. These strategy tasks can be executed or non-executed when they are predefined based on strategy group setup, or executed ad hoc, user-defined tasks.
Show Source
Nested Schema : Strategy Template Tasks
Type:
array
Title:
Strategy Template Tasks
A strategy template task resource is used to retrieve all future tasks that are defined from the strategy setup template and skipped template tasks.
Show Source
Nested Schema : User Tasks
Type:
array
Title:
User Tasks
The user tasks resource is used to create, update, or view any ad hoc strategy tasks that collectors want to add to the list of predefined strategy tasks for a particular strategy assignment.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
AssignedTo: string
Title:
Assigned To
Maximum Length:255
The collector assigned to the strategy execution task. The value of Assigned To is populated by default as the collector assigned to the customer, account, or site, depending on the business level. -
ExecutionEnd: string
(date-time)
Title:
Execution End
The actual end date of the strategy execution task. -
ExecutionStart: string
(date-time)
Title:
Execution Start
The actual start date of the strategy execution task. -
PostWaitEndTime: string
(date)
Title:
Postwait End Time
The post wait end date of the strategy execution task that has post-wait time defined. -
ScheduleEnd: string
(date-time)
Title:
Schedule End
The scheduled end date of the strategy execution task. -
ScheduleStart: string
(date-time)
Title:
Schedule Start
The scheduled start date of the strategy execution task. -
StrategyTaskTemplate: string
Title:
Strategy Task Template
Maximum Length:240
The strategy task template used for the strategy execution task. This is a mandatory attribute. -
TaskStatus: string
Title:
Task Status
The status of the strategy execution task. -
WorkItemId: integer
(int64)
Title:
Work Item ID
The unique identifier of the strategy execution task or work item. -
WorkOrder: integer
(int64)
Title:
Work Order
The work order of the strategy execution task.
Nested Schema : collectionStrategies-strategyTemplateTasks-item-post-request
Type:
Show Source
object
-
TemplateTaskId: integer
(int64)
Title:
Template Task Id
The unique identifier of the strategy template task. -
TemplateTaskName: string
Title:
Template Task Name
The task name used for strategy template task. -
TemplateTaskStatus: string
Title:
Template Task Status
The task status of the strategy template task. -
WorkOrder: integer
(int64)
Title:
Work Order
The work order of strategy template task.
Nested Schema : schema
Type:
Show Source
object
-
StrategyTaskTemplate: string
Title:
Strategy Task Template
Maximum Length:240
The strategy task template used for the strategy user task. This is a mandatory attribute. -
UserItemId: integer
(int64)
Title:
User Item ID
The unique identifier of the strategy user task. -
UserTaskStatus: string
Title:
User Task Status
The status of the strategy user task. The default value of the User Task Status is NOT CREATED. -
WorkOrder: integer
(int64)
Title:
Work Order
The work order of the strategy user task. This is a mandatory attribute.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : collectionStrategies-item-response
Type:
Show Source
object
-
AccountNumber: string
Title:
Account Number
Maximum Length:30
The customer account to which the strategy is assigned. -
BusinessUnit: string
Title:
Business Unit
Maximum Length:240
The business unit under which the strategy assignment is created. -
ChangeStrategy: string
The change strategy attribute is used to override the existing strategy with a new strategy. This is an optional attribute. The valid value is Y.
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NextStrategyTask: string
Title:
Next Strategy Task
Maximum Length:255
The next strategy task of the strategy assignment. When the strategy execution tasks are created, the value of Next Strategy Task is set to the open strategy task. -
PartyName: string
Title:
Party Name
Read Only:true
Maximum Length:360
The name of the customer to which the strategy is assigned. The value of Party Name is populated by default based on the Party Number value. -
PartyNumber: string
Title:
Party Number
Maximum Length:30
The unique identification number of the customer to which the strategy is assigned. This is a mandatory attribute. -
Score: number
Title:
Score
The score of the customer, account, or site used for the strategy assignment. -
SiteUse: string
Title:
Site
Maximum Length:150
The customer site to which the strategy is assigned. -
strategyExecutionTasks: array
Tasks
Title:
Tasks
The tasks resource is used to create, update, or view strategy tasks assigned to customers, customer accounts, or sites, depending on the customers' business levels. These strategy tasks can be executed or non-executed when they are predefined based on strategy group setup, or executed ad hoc, user-defined tasks. -
StrategyId: integer
(int64)
Title:
Strategy ID
The unique identifier of the strategy assignment. -
StrategyStatus: string
Title:
Strategy Status
Maximum Length:255
The status of the strategy assignment. -
StrategyTemplate: string
Title:
Strategy Template
Maximum Length:240
The strategy template used for the strategy assignment. This is a mandatory attribute. -
strategyTemplateTasks: array
Strategy Template Tasks
Title:
Strategy Template Tasks
A strategy template task resource is used to retrieve all future tasks that are defined from the strategy setup template and skipped template tasks. -
strategyUserTasks: array
User Tasks
Title:
User Tasks
The user tasks resource is used to create, update, or view any ad hoc strategy tasks that collectors want to add to the list of predefined strategy tasks for a particular strategy assignment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Tasks
Type:
array
Title:
Tasks
The tasks resource is used to create, update, or view strategy tasks assigned to customers, customer accounts, or sites, depending on the customers' business levels. These strategy tasks can be executed or non-executed when they are predefined based on strategy group setup, or executed ad hoc, user-defined tasks.
Show Source
Nested Schema : Strategy Template Tasks
Type:
array
Title:
Strategy Template Tasks
A strategy template task resource is used to retrieve all future tasks that are defined from the strategy setup template and skipped template tasks.
Show Source
Nested Schema : User Tasks
Type:
array
Title:
User Tasks
The user tasks resource is used to create, update, or view any ad hoc strategy tasks that collectors want to add to the list of predefined strategy tasks for a particular strategy assignment.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : collectionStrategies-strategyExecutionTasks-item-response
Type:
Show Source
object
-
AssignedTo: string
Title:
Assigned To
Maximum Length:255
The collector assigned to the strategy execution task. The value of Assigned To is populated by default as the collector assigned to the customer, account, or site, depending on the business level. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
ExecutionEnd: string
(date-time)
Title:
Execution End
The actual end date of the strategy execution task. -
ExecutionStart: string
(date-time)
Title:
Execution Start
The actual start date of the strategy execution task. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostWaitEndTime: string
(date)
Title:
Postwait End Time
The post wait end date of the strategy execution task that has post-wait time defined. -
ScheduleEnd: string
(date-time)
Title:
Schedule End
The scheduled end date of the strategy execution task. -
ScheduleStart: string
(date-time)
Title:
Schedule Start
The scheduled start date of the strategy execution task. -
StrategyTaskTemplate: string
Title:
Strategy Task Template
Maximum Length:240
The strategy task template used for the strategy execution task. This is a mandatory attribute. -
TaskStatus: string
Title:
Task Status
The status of the strategy execution task. -
TaskType: string
Title:
Task Type
Read Only:true
Maximum Length:80
The type of the strategy execution task. The value of Task Type is set based on the strategy task template. -
WorkItemId: integer
(int64)
Title:
Work Item ID
The unique identifier of the strategy execution task or work item. -
WorkOrder: integer
(int64)
Title:
Work Order
The work order of the strategy execution task.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : collectionStrategies-strategyTemplateTasks-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
TemplateTaskId: integer
(int64)
Title:
Template Task Id
The unique identifier of the strategy template task. -
TemplateTaskName: string
Title:
Template Task Name
The task name used for strategy template task. -
TemplateTaskStatus: string
Title:
Template Task Status
The task status of the strategy template task. -
TemplateTaskType: string
Title:
Template Task Type
Read Only:true
Maximum Length:80
The task type of strategy template task. -
WorkOrder: integer
(int64)
Title:
Work Order
The work order of strategy template task.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : collectionStrategies-strategyUserTasks-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
StrategyTaskTemplate: string
Title:
Strategy Task Template
Maximum Length:240
The strategy task template used for the strategy user task. This is a mandatory attribute. -
UserItemId: integer
(int64)
Title:
User Item ID
The unique identifier of the strategy user task. -
UserTaskStatus: string
Title:
User Task Status
The status of the strategy user task. The default value of the User Task Status is NOT CREATED. -
UserTaskType: string
Title:
User Task Type
Read Only:true
Maximum Length:80
The type of the strategy user task. The value of User Task Type is set based on the strategy task template. -
WorkOrder: integer
(int64)
Title:
Work Order
The work order of the strategy user task. This is a mandatory attribute.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- strategyExecutionTasks
-
Operation: /fscmRestApi/resources/11.13.18.05/collectionStrategies/{StrategyId}/child/strategyExecutionTasksParameters:
- StrategyId:
$request.path.StrategyId
The tasks resource is used to create, update, or view strategy tasks assigned to customers, customer accounts, or sites, depending on the customers' business levels. These strategy tasks can be executed or non-executed when they are predefined based on strategy group setup, or executed ad hoc, user-defined tasks. - StrategyId:
- strategyTemplateTasks
-
Operation: /fscmRestApi/resources/11.13.18.05/collectionStrategies/{StrategyId}/child/strategyTemplateTasksParameters:
- StrategyId:
$request.path.StrategyId
A strategy template task resource is used to retrieve all future tasks that are defined from the strategy setup template and skipped template tasks. - StrategyId:
- strategyUserTasks
-
Operation: /fscmRestApi/resources/11.13.18.05/collectionStrategies/{StrategyId}/child/strategyUserTasksParameters:
- StrategyId:
$request.path.StrategyId
The user tasks resource is used to create, update, or view any ad hoc strategy tasks that collectors want to add to the list of predefined strategy tasks for a particular strategy assignment. - StrategyId:
Examples
The following example shows how to create a strategy assignment by submitting a POST request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X POST -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/collectionStrategies
Example Request Payload
The following example shows the contents of the request body in JSON format:
{ "Score": 60.4, "StrategyTemplate": "W3 Site Collections Strategy", "BusinessUnit": "Vision Operations", "PartyNumber":"CDRM_739286", "AccountNumber":"CDRM_149201", "SiteUse": "CDRM_121208", "StrategyStatus": "Open" }
Example of Response Body
The following example shows the contents of the response body in JSON format:
{ "StrategyId": 300100169827834, "Score": 60.4, "AccountNumber": "CDRM_149201", "PartyName": "IEX_Customer001", "PartyNumber": "CDRM_739286", "SiteUse": "CDRM_121208", "NextStrategyTask": null, "CreatedBy": "COLLECTIONS_MGR_OPERATIONS", "CreationDate": "2018-10-18T07:12:21+00:00", "LastUpdateDate": "2018-10-18T07:12:21.226+00:00", "LastUpdatedBy": "COLLECTIONS_MGR_OPERATIONS", "StrategyStatus": "Open", "BusinessUnit": "Vision Operations", "StrategyTemplate": "W3 Site Collections Strategy", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/collectionStrategies/300100169827834", "name": "collectionStrategies", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/collectionStrategies/300100169827834", "name": "collectionStrategies", "kind": "item" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/collectionStrategies/300100169827834/lov/businessUnits", "name": "businessUnits", "kind": "collection" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/collectionStrategies/300100169827834/lov/customerSiteUses", "name": "customerSiteUses", "kind": "collection" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/collectionStrategies/300100169827834/lov/customerAccounts", "name": "customerAccounts", "kind": "collection" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/collectionStrategies/300100169827834/lov/parties", "name": "parties", "kind": "collection" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/collectionStrategies/300100169827834/lov/strategyTemplates", "name": "strategyTemplates", "kind": "collection" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/collectionStrategies/300100169827834/lov/strategyStatuses", "name": "strategyStatuses", "kind": "collection" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/collectionStrategies/300100169827834/child/strategyUserTasks", "name": "strategyUserTasks", "kind": "collection" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/collectionStrategies/300100169827834/child/strategyExecutionTasks", "name": "strategyExecutionTasks", "kind": "collection" } ] }