Get all strategy assignments
get
/fscmRestApi/resources/11.13.18.05/collectionStrategies
Request
Query Parameters
-
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- PrimaryKey: Finds the collections strategy assignment that matches the primary key criteria specified.
Finder Variables:- StrategyId; integer; The unique identifier of the strategy assignment.
- collectionStrategySearch: Finds the collections strategy assignment with the specified customer, business unit, and strategy group.
Finder Variables:- BindBusinessUnit; string; The business unit under which the strategy assignment is created.
- BindPartyName; string; The name of the customer assigned to the strategy.
- BindPartyNumber; string; The unique identification number of the customer assigned to the strategy.
- BindStrategyTemplate; string; The strategy group or strategy template used for the strategy assignment.
- PrimaryKey: Finds the collections strategy assignment that matches the primary key criteria specified.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- AccountNumber; string; The customer account to which the strategy is assigned.
- BusinessUnit; string; The business unit under which the strategy assignment is created.
- CreatedBy; string; The user who created the record.
- CreationDate; string; The date when the record was created.
- LastUpdateDate; string; The date when the record was last updated.
- LastUpdatedBy; string; The user who last updated the record.
- PartyName; string; 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; The unique identification number of the customer to which the strategy is assigned. This is a mandatory attribute.
- Score; number; The score of the customer, account, or site used for the strategy assignment.
- SiteUse; string; The customer site to which the strategy is assigned.
- StrategyId; integer; The unique identifier of the strategy assignment.
- StrategyTemplate; string; The strategy template used for the strategy assignment. This is a mandatory attribute.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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.
There's no request body for this operation.
Back to TopResponse
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
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested 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
Examples
The following example shows how to retrieve all the strategy assignments by submitting a GET request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/collectionStrategies
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "items": [ { "StrategyId": 100100055492071, "Score": 76, "AccountNumber": null, "PartyName": "B2CM_Customer01", "PartyNumber": "CDRM_68991", "SiteUse": null, "NextStrategyTask": "Default Work Item", "CreatedBy": "COLLECTIONS_MGR_OPERATIONS", "CreationDate": "2017-07-27T13:37:48+00:00", "LastUpdateDate": "2018-03-21T00:00:00+00:00", "LastUpdatedBy": "COLLECTIONS_MGR_OPERATIONS", "StrategyStatus": "Canceled", "BusinessUnit": "Vision Operations", "StrategyTemplate": "Customer Catch-all Collections Strategy", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/collectionStrategies/100100055492071", "name": "collectionStrategies", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/collectionStrategies/100100055492071", "name": "collectionStrategies", "kind": "item" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/collectionStrategies/100100055492071/lov/businessUnits", "name": "businessUnits", "kind": "collection" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/collectionStrategies/100100055492071/lov/customerSiteUses", "name": "customerSiteUses", "kind": "collection" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/collectionStrategies/100100055492071/lov/customerAccounts", "name": "customerAccounts", "kind": "collection" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/collectionStrategies/100100055492071/lov/parties", "name": "parties", "kind": "collection" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/collectionStrategies/100100055492071/lov/strategyTemplates", "name": "strategyTemplates", "kind": "collection" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/collectionStrategies/100100055492071/lov/strategyStatuses", "name": "strategyStatuses", "kind": "collection" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/collectionStrategies/100100055492071/child/strategyUserTasks", "name": "strategyUserTasks", "kind": "collection" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/collectionStrategies/100100055492071/child/strategyExecutionTasks", "name": "strategyExecutionTasks", "kind": "collection" } ] },... ], "count": 25, "hasMore": true, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/collectionStrategies", "name": "collectionStrategies", "kind": "collection" } ] }