Jump to

• Request
• Response
• Examples

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "SiteUse":{
            "title":"Site",
            "maxLength":150,
            "type":"string",
            "description":"The customer site to which the strategy is assigned.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "StrategyId":{
            "title":"Strategy ID",
            "type":"integer",
            "description":"The unique identifier of the strategy assignment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "StrategyStatus":{
            "title":"Strategy Status",
            "maxLength":255,
            "type":"string",
            "description":"The status of the strategy assignment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"default"
            }
        },
        "strategyExecutionTasks":{
            "title":"Tasks",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/collectionStrategies-strategyExecutionTasks-item-post-request"
            }
        },
        "NextStrategyTask":{
            "title":"Next Strategy Task",
            "maxLength":255,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "AccountNumber":{
            "title":"Account Number",
            "maxLength":30,
            "type":"string",
            "description":"The customer account to which the strategy is assigned.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "strategyUserTasks":{
            "title":"User Tasks",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/collectionStrategies-strategyUserTasks-item-post-request"
            }
        },
        "Score":{
            "title":"Score",
            "type":"number",
            "description":"The score of the customer, account, or site used for the strategy assignment.",
            "nullable":true
        },
        "PartyNumber":{
            "title":"Party Number",
            "maxLength":30,
            "type":"string",
            "description":"The unique identification number of the customer to which the strategy is assigned. This is a mandatory attribute.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ChangeStrategy":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "strategyTemplateTasks":{
            "title":"Strategy Template Tasks",
            "type":"array",
            "description":"A strategy template task resource is used to retrieve all future tasks that are defined from the strategy setup template and skipped template tasks.",
            "items":{
                "$ref":"#/components/schemas/collectionStrategies-strategyTemplateTasks-item-post-request"
            }
        },
        "BusinessUnit":{
            "title":"Business Unit",
            "maxLength":240,
            "type":"string",
            "description":"The business unit under which the strategy assignment is created.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "StrategyTemplate":{
            "title":"Strategy Template",
            "maxLength":240,
            "type":"string",
            "description":"The strategy template used for the strategy assignment. This is a mandatory attribute.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

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

• Array of: object schema

{
    "title":"Tasks",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/collectionStrategies-strategyExecutionTasks-item-post-request"
    }
}

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

• Array of: object collectionStrategies-strategyTemplateTasks-item-post-request

{
    "title":"Strategy Template Tasks",
    "type":"array",
    "description":"A strategy template task resource is used to retrieve all future tasks that are defined from the strategy setup template and skipped template tasks.",
    "items":{
        "$ref":"#/components/schemas/collectionStrategies-strategyTemplateTasks-item-post-request"
    }
}

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

• Array of: object schema

{
    "title":"User Tasks",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/collectionStrategies-strategyUserTasks-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "AssignedTo":{
            "title":"Assigned To",
            "maxLength":255,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "StrategyTaskTemplate":{
            "title":"Strategy Task Template",
            "maxLength":240,
            "type":"string",
            "description":"The strategy task template used for the strategy execution task. This is a mandatory attribute.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "WorkOrder":{
            "title":"Work Order",
            "type":"integer",
            "description":"The work order of the strategy execution task.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ExecutionStart":{
            "title":"Execution Start",
            "type":"string",
            "description":"The actual start date of the strategy execution task.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "ScheduleEnd":{
            "title":"Schedule End",
            "type":"string",
            "description":"The scheduled end date of the strategy execution task.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "WorkItemId":{
            "title":"Work Item ID",
            "type":"integer",
            "description":"The unique identifier of the strategy execution task or work item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "PostWaitEndTime":{
            "title":"Postwait End Time",
            "type":"string",
            "description":"The post wait end date of the strategy execution task that has post-wait time defined.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "ScheduleStart":{
            "title":"Schedule Start",
            "type":"string",
            "description":"The scheduled start date of the strategy execution task.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "TaskStatus":{
            "title":"Task Status",
            "type":"string",
            "description":"The status of the strategy execution task.",
            "nullable":true,
            "x-queryable":false
        },
        "ExecutionEnd":{
            "title":"Execution End",
            "type":"string",
            "description":"The actual end date of the strategy execution task.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Nested Schema : collectionStrategies-strategyTemplateTasks-item-post-request

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "TemplateTaskStatus":{
            "title":"Template Task Status",
            "type":"string",
            "description":"The task status of the strategy template task.",
            "nullable":true,
            "x-queryable":false
        },
        "WorkOrder":{
            "title":"Work Order",
            "type":"integer",
            "description":"The work order of strategy template task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TemplateTaskId":{
            "title":"Template Task Id",
            "type":"integer",
            "description":"The unique identifier of the strategy template task.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "StrategyIdTemplate"
                ]
            }
        },
        "TemplateTaskName":{
            "title":"Template Task Name",
            "type":"string",
            "description":"The task name used for strategy template task.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "TemplateTaskName1"
                ]
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "UserItemId":{
            "title":"User Item ID",
            "type":"integer",
            "description":"The unique identifier of the strategy user task.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "StrategyTaskTemplate":{
            "title":"Strategy Task Template",
            "maxLength":240,
            "type":"string",
            "description":"The strategy task template used for the strategy user task. This is a mandatory attribute.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "WorkOrder":{
            "title":"Work Order",
            "type":"integer",
            "description":"The work order of the strategy user task. This is a mandatory attribute.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "UserTaskStatus":{
            "title":"User Task Status",
            "type":"string",
            "description":"The status of the strategy user task. The default value of the User Task Status is NOT CREATED.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "UserTaskStatusMeaning"
                ]
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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(required):
  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.

Body ()

Root Schema : collectionStrategies-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SiteUse":{
            "title":"Site",
            "maxLength":150,
            "type":"string",
            "description":"The customer site to which the strategy is assigned.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StrategyId":{
            "title":"Strategy ID",
            "type":"integer",
            "description":"The unique identifier of the strategy assignment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PartyName":{
            "title":"Party Name",
            "maxLength":360,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StrategyStatus":{
            "title":"Strategy Status",
            "maxLength":255,
            "type":"string",
            "description":"The status of the strategy assignment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"default"
            }
        },
        "strategyExecutionTasks":{
            "title":"Tasks",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/collectionStrategies-strategyExecutionTasks-item-response"
            }
        },
        "NextStrategyTask":{
            "title":"Next Strategy Task",
            "maxLength":255,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "AccountNumber":{
            "title":"Account Number",
            "maxLength":30,
            "type":"string",
            "description":"The customer account to which the strategy is assigned.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "strategyUserTasks":{
            "title":"User Tasks",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/collectionStrategies-strategyUserTasks-item-response"
            }
        },
        "Score":{
            "title":"Score",
            "type":"number",
            "description":"The score of the customer, account, or site used for the strategy assignment.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyNumber":{
            "title":"Party Number",
            "maxLength":30,
            "type":"string",
            "description":"The unique identification number of the customer to which the strategy is assigned. This is a mandatory attribute.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ChangeStrategy":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "strategyTemplateTasks":{
            "title":"Strategy Template Tasks",
            "type":"array",
            "description":"A strategy template task resource is used to retrieve all future tasks that are defined from the strategy setup template and skipped template tasks.",
            "items":{
                "$ref":"#/components/schemas/collectionStrategies-strategyTemplateTasks-item-response"
            }
        },
        "BusinessUnit":{
            "title":"Business Unit",
            "maxLength":240,
            "type":"string",
            "description":"The business unit under which the strategy assignment is created.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "StrategyTemplate":{
            "title":"Strategy Template",
            "maxLength":240,
            "type":"string",
            "description":"The strategy template used for the strategy assignment. This is a mandatory attribute.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

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

• Array of: object collectionStrategies-strategyExecutionTasks-item-response

{
    "title":"Tasks",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/collectionStrategies-strategyExecutionTasks-item-response"
    }
}

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

• Array of: object collectionStrategies-strategyTemplateTasks-item-response

{
    "title":"Strategy Template Tasks",
    "type":"array",
    "description":"A strategy template task resource is used to retrieve all future tasks that are defined from the strategy setup template and skipped template tasks.",
    "items":{
        "$ref":"#/components/schemas/collectionStrategies-strategyTemplateTasks-item-response"
    }
}

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

• Array of: object collectionStrategies-strategyUserTasks-item-response

{
    "title":"User Tasks",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/collectionStrategies-strategyUserTasks-item-response"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : collectionStrategies-strategyExecutionTasks-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StrategyTaskTemplate":{
            "title":"Strategy Task Template",
            "maxLength":240,
            "type":"string",
            "description":"The strategy task template used for the strategy execution task. This is a mandatory attribute.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ScheduleEnd":{
            "title":"Schedule End",
            "type":"string",
            "description":"The scheduled end date of the strategy execution task.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "TaskStatus":{
            "title":"Task Status",
            "type":"string",
            "description":"The status of the strategy execution task.",
            "nullable":true,
            "x-queryable":false
        },
        "AssignedTo":{
            "title":"Assigned To",
            "maxLength":255,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "WorkOrder":{
            "title":"Work Order",
            "type":"integer",
            "description":"The work order of the strategy execution task.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ExecutionStart":{
            "title":"Execution Start",
            "type":"string",
            "description":"The actual start date of the strategy execution task.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "TaskType":{
            "title":"Task Type",
            "maxLength":80,
            "type":"string",
            "description":"The type of the strategy execution task. The value of Task Type is set based on the strategy task template.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "WorkItemTypeCode"
                ]
            },
            "x-queryable":true
        },
        "WorkItemId":{
            "title":"Work Item ID",
            "type":"integer",
            "description":"The unique identifier of the strategy execution task or work item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PostWaitEndTime":{
            "title":"Postwait End Time",
            "type":"string",
            "description":"The post wait end date of the strategy execution task that has post-wait time defined.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "ScheduleStart":{
            "title":"Schedule Start",
            "type":"string",
            "description":"The scheduled start date of the strategy execution task.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "ExecutionEnd":{
            "title":"Execution End",
            "type":"string",
            "description":"The actual end date of the strategy execution task.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : collectionStrategies-strategyTemplateTasks-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "TemplateTaskType":{
            "title":"Template Task Type",
            "maxLength":80,
            "type":"string",
            "description":"The task type of strategy template task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "TemplateTaskStatus":{
            "title":"Template Task Status",
            "type":"string",
            "description":"The task status of the strategy template task.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "WorkOrder":{
            "title":"Work Order",
            "type":"integer",
            "description":"The work order of strategy template task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TemplateTaskId":{
            "title":"Template Task Id",
            "type":"integer",
            "description":"The unique identifier of the strategy template task.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "StrategyIdTemplate"
                ]
            },
            "x-queryable":true
        },
        "TemplateTaskName":{
            "title":"Template Task Name",
            "type":"string",
            "description":"The task name used for strategy template task.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "TemplateTaskName1"
                ]
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : collectionStrategies-strategyUserTasks-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StrategyTaskTemplate":{
            "title":"Strategy Task Template",
            "maxLength":240,
            "type":"string",
            "description":"The strategy task template used for the strategy user task. This is a mandatory attribute.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "WorkOrder":{
            "title":"Work Order",
            "type":"integer",
            "description":"The work order of the strategy user task. This is a mandatory attribute.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UserItemId":{
            "title":"User Item ID",
            "type":"integer",
            "description":"The unique identifier of the strategy user task.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UserTaskType":{
            "title":"User Task Type",
            "maxLength":80,
            "type":"string",
            "description":"The type of the strategy user task. The value of User Task Type is set based on the strategy task template.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UserTaskStatus":{
            "title":"User Task Status",
            "type":"string",
            "description":"The status of the strategy user task. The default value of the User Task Status is NOT CREATED.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "UserTaskStatusMeaning"
                ]
            }
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

strategyExecutionTasks

Operation: /fscmRestApi/resources/11.13.18.05/collectionStrategies/{StrategyId}/child/strategyExecutionTasks

Parameters:

• 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.

strategyTemplateTasks

Operation: /fscmRestApi/resources/11.13.18.05/collectionStrategies/{StrategyId}/child/strategyTemplateTasks

Parameters:

• 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.

strategyUserTasks

Operation: /fscmRestApi/resources/11.13.18.05/collectionStrategies/{StrategyId}/child/strategyUserTasks

Parameters:

• 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.

Back to Top

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"
        }
    ]
}

Back to Top