Create planning cycles
post
/fscmRestApi/resources/11.13.18.05/planningCycles
Request
Header Parameters
-
Metadata-Context: string
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: string
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: string
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
-
PlanningCycleDescription: string
Maximum Length:
100
Description of the planning cycle. -
PlanningCycleEndDate(required): string
(date)
Date when the planning cycle ends.
-
PlanningCycleId: integer
(int64)
Value that uniquely identifies the planning cycle.
-
PlanningCycleName(required): string
Maximum Length:
100
Name of the planning cycle. -
PlanningCycleOwnerId: string
Maximum Length:
64
Value that uniquely identifies who owns the planning cycle. -
planningCyclePlans: array
Planning Cycle Plans
Title:
Planning Cycle Plans
A planning cycle has one or more linked supply chain plans to analyze. For example, you can include the current baseline plan and alternative plans in the planning cycle. The links that you set up for an activity or task opens reports in the plans. -
planningCycleStages: array
Planning Cycle Stages
Title:
Planning Cycle Stages
A review stage represents the activities, tasks, and participants in a recurring planning process. For example, Demand Review and Supply Review are stages in a sales and operations planning process -
PlanningCycleStartDate(required): string
(date)
Date when the planning cycle starts.
-
PlanningCycleStatusCode: integer
(int32)
Status of the planning cycle. Contains one of the following values. 0: Not started, 1: In progress, or 2: Completed.
-
planningCycleWorkLists: array
Planning Cycle Worklists
Title:
Planning Cycle Worklists
A worklist is a list of planning tasks that require user action.
Nested Schema : Planning Cycle Plans
Type:
array
Title:
Planning Cycle Plans
A planning cycle has one or more linked supply chain plans to analyze. For example, you can include the current baseline plan and alternative plans in the planning cycle. The links that you set up for an activity or task opens reports in the plans.
Show Source
Nested Schema : Planning Cycle Stages
Type:
array
Title:
Planning Cycle Stages
A review stage represents the activities, tasks, and participants in a recurring planning process. For example, Demand Review and Supply Review are stages in a sales and operations planning process
Show Source
Nested Schema : Planning Cycle Worklists
Type:
array
Title:
Planning Cycle Worklists
A worklist is a list of planning tasks that require user action.
Show Source
Nested Schema : planningCycles-planningCyclePlans-item-post-request
Type:
Show Source
object
-
PlanningCycleId: integer
(int64)
Value that uniquely identifies the planning cycle associated with the plan.
-
PlanningCyclePlansPlanId: integer
(int64)
Value that uniquely identifies the plan associated with the planning cycle.
-
PlanningCyclePlansPlanName: string
Maximum Length:
30
Name of the plan associated with the planning cycle.
Nested Schema : planningCycles-planningCycleStages-item-post-request
Type:
Show Source
object
-
planningCycleActionDecisionItems: array
Action and Decision Items
Title:
Action and Decision Items
An action item is an unplanned task assigned in a planning cycle stage. A decision item is a recommendation or an alternative to consider during a review stage meeting. -
planningCycleActivities: array
Activities
Title:
Activities
An activity is a group of related planning tasks in a planning cycle stage. -
PlanningCycleId(required): integer
(int64)
Value that uniquely identifies the planning cycle.
-
planningCycleParticipants: array
Participants
Title:
Participants
A group of users to assign tasks as owners and assignees in a planning cycle stage. -
PlanningCycleStageDisplayOrder(required): integer
(int32)
Value that indicates the display order of the stage in the planning cycle.
-
PlanningCycleStageId: integer
(int64)
Value that uniquely identifies the planning cycle stage.
-
PlanningCycleStageName(required): string
Maximum Length:
256
Name of the planning cycle stage.
Nested Schema : Action and Decision Items
Type:
array
Title:
Action and Decision Items
An action item is an unplanned task assigned in a planning cycle stage. A decision item is a recommendation or an alternative to consider during a review stage meeting.
Show Source
Nested Schema : Activities
Type:
array
Title:
Activities
An activity is a group of related planning tasks in a planning cycle stage.
Show Source
Nested Schema : Participants
Type:
array
Title:
Participants
A group of users to assign tasks as owners and assignees in a planning cycle stage.
Show Source
Nested Schema : planningCycles-planningCycleStages-planningCycleActionDecisionItems-item-post-request
Type:
Show Source
object
-
PlanningCycleTaskAssigneeId: string
Maximum Length:
64
Value that uniquely identifies who's assigned the action and decision item in the planning cycle stage. -
PlanningCycleTaskComments: string
Maximum Length:
1000
Description of the planning cycle. -
PlanningCycleTaskCompletionDate: string
(date)
Date when the action and decision item in the planning cycle stage is completed.
-
PlanningCycleTaskDueDate: string
(date)
Date when the action and decision item in the planning cycle stage is due.
-
PlanningCycleTaskId: integer
(int64)
Value that uniquely identifies the action and decision item in the planning cycle stage.
-
PlanningCycleTaskLink: string
Maximum Length:
256
Name of the report link associated with the action and decision item in the planning cycle stage. -
PlanningCycleTaskLinkId: integer
(int64)
Value that uniquely identifies the report link associated with the action and decision item in the planning cycle stage.
-
PlanningCycleTaskLinkType: integer
(int32)
Type of report link associated with the action and decision item task in the planning cycle stage. A valid value includes 2 for page group.
-
PlanningCycleTaskOffSetDays: integer
(int64)
Value that specifies the task due date relative to the start of the planning cycle. For example, a value of 10 indicates the task is due 10 days after the start of the planning cycle.
-
PlanningCycleTaskOwnerId: string
Maximum Length:
64
Value that uniquely identifies who owns the action and decision item in the planning cycle stage. -
PlanningCycleTaskStageId: integer
(int64)
Value that uniquely identifies the planning cycle stage associated with the action and decision item.
-
PlanningCycleTaskStatusCode: string
Maximum Length:
32
Status of the action and decision item in the planning cycle stage. A list of valid values for the action item is defined in the lookup type ORA_MSC_SOP_TASK_STATUS. A list of valid values for the decision item is defined in the lookup type ORA_MSC_SOP_RECOMMEND_STATUS. -
PlanningCycleTaskTitle: string
Maximum Length:
100
Name of the action and decision item in the planning cycle stage. -
PlanningCycleTaskTypeCode: string
Maximum Length:
64
Type of action and decision item in the planning cycle stage. Contains one of the following values. 1: Action or 2: Decision.
Nested Schema : planningCycles-planningCycleStages-planningCycleActivities-item-post-request
Type:
Show Source
object
-
PlanningCycleActivityAssigneeId: string
Maximum Length:
64
Value that uniquely identifies who's assigned the activity in the planning cycle stage. -
PlanningCycleActivityCompletionDate: string
(date)
Date when the activity in the planning cycle stage is completed.
-
PlanningCycleActivityDescription: string
Maximum Length:
256
Description of the activity in the planning cycle stage. -
PlanningCycleActivityDisplayOrder(required): integer
(int64)
Value that indicates the display order of the activity in the planning cycle stage.
-
PlanningCycleActivityDueDate: string
(date)
Date when the activity in the planning cycle stage is due.
-
PlanningCycleActivityId: integer
(int64)
Value that uniquely identifies the activity in the planning cycle stage.
-
PlanningCycleActivityLink: string
Maximum Length:
256
Name of the report link associated with the activity in the planning cycle stage. -
PlanningCycleActivityLinkId: integer
(int64)
Value that uniquely identifies the report link associated with the activity in the planning cycle stage.
-
PlanningCycleActivityLinkType: integer
(int32)
Type of report link associated with the activity in the planning cycle stage. A valid value includes 2 for page group.
-
PlanningCycleActivityName(required): string
Maximum Length:
256
Name of the activity in the planning cycle stage. -
PlanningCycleActivityOwnerId: string
Maximum Length:
64
Value that uniquely identifies who owns the activity in the planning cycle stage. -
PlanningCycleActivityStageId: integer
(int64)
Value that uniquely identifies the planning cycle stage associated with the activity.
-
PlanningCycleActivityStatusCode: string
Maximum Length:
32
Status of the activity in the planning cycle stage derived from its tasks. A list of valid values for the activity is defined in the lookup type ORA_MSC_SOP_TASK_STATUS. -
PlanningCycleActivityType: string
Maximum Length:
80
Name of the type of activity in the planning cycle stage. A list of valid names for the activity is defined in the lookup type ORA_MSC_SOP_ACTIVITY_TASK_TYPE. -
PlanningCycleActivityTypeCode: string
Maximum Length:
64
Type of activity in the planning cycle stage. A list of valid values for the activity is defined in the lookup type ORA_MSC_SOP_ACTIVITY_TASK_TYPE. -
planningCycleTasks: array
Tasks
Title:
Tasks
A recurring task that has an owner and an assignee in a planning cycle stage.
Nested Schema : Tasks
Type:
array
Title:
Tasks
A recurring task that has an owner and an assignee in a planning cycle stage.
Show Source
Nested Schema : planningCycles-planningCycleStages-planningCycleActivities-planningCycleTasks-item-post-request
Type:
Show Source
object
-
PlanningCycleTaskAssigneeId: string
Maximum Length:
64
Value that uniquely identifies who's assigned the task in the planning cycle stage. -
PlanningCycleTaskCompletionDate: string
(date)
Date when the task in the planning cycle stage is completed.
-
PlanningCycleTaskDueDate: string
(date)
Date when the task in the planning cycle stage is due.
-
PlanningCycleTaskId: integer
(int64)
Value that uniquely identifies the task in the planning cycle stage.
-
PlanningCycleTaskLinkId: integer
(int64)
Value that uniquely identifies the report link associated with the task in the planning cycle stage.
-
PlanningCycleTaskLinktype: integer
(int32)
Type of report link associated with the task in the planning cycle stage. A valid value includes 2 for page group.
-
PlanningCycleTaskOffSetDays: integer
(int64)
Value that specifies the task due date relative to the start of the planning cycle. For example, a value of 10 indicates the task is due 10 days after the start of the planning cycle.
-
PlanningCycleTaskOwnerId: string
Maximum Length:
64
Value that uniquely identifies who owns the task in the planning cycle stage. -
PlanningCycleTaskStageId: integer
(int64)
Value that uniquely identifies the planning cycle stage associated with the task.
-
PlanningCycleTaskStatusCode: string
Maximum Length:
32
Status of the task in the planning cycle stage. A list of valid values for the task is defined in the lookup type ORA_MSC_SOP_TASK_STATUS. -
PlanningCycleTaskTitle: string
Maximum Length:
100
Name of the task in the planning cycle stage. -
PlanningCycleTaskType: string
Maximum Length:
80
Name of the type of task in the planning cycle stage. A list of valid names for the task is defined in the lookup type ORA_MSC_SOP_ACTIVITY_TASK_TYPE. -
PlanningCycleTaskTypeCode: string
Maximum Length:
64
Type of task in the planning cycle stage. A list of valid values for the task is defined in the lookup type ORA_MSC_SOP_ACTIVITY_TASK_TYPE. -
PlannningCycleTaskLink: string
Maximum Length:
256
Name of the report link associated with the task in the planning cycle stage.
Nested Schema : schema
Type:
Show Source
object
-
PlanningCycleId: integer
(int64)
Value that uniquely identifies the planning cycle in which the user is a participant.
-
PlanningCycleParticipantId: string
Maximum Length:
64
Value that uniquely identifies the user who's a participant in the planning cycle stage. -
PlanningCycleParticipantsStageId: integer
(int64)
Value that uniquely identifies the planning cycle stage in which the user is a participant.
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 : planningCycles-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the planning cycle. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the planning cycle. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the planning cycle. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the planning cycle. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PlanningCycleDescription: string
Maximum Length:
100
Description of the planning cycle. -
PlanningCycleEndDate: string
(date)
Date when the planning cycle ends.
-
PlanningCycleId: integer
(int64)
Value that uniquely identifies the planning cycle.
-
PlanningCycleName: string
Maximum Length:
100
Name of the planning cycle. -
PlanningCycleOwner: string
Read Only:
true
Maximum Length:255
Name of the user who owns the planning cycle. -
PlanningCycleOwnerId: string
Maximum Length:
64
Value that uniquely identifies who owns the planning cycle. -
planningCyclePlans: array
Planning Cycle Plans
Title:
Planning Cycle Plans
A planning cycle has one or more linked supply chain plans to analyze. For example, you can include the current baseline plan and alternative plans in the planning cycle. The links that you set up for an activity or task opens reports in the plans. -
PlanningCyclePlansDetail: string
Read Only:
true
Maximum Length:4000
List of plans associated with the planning cycle. A comma separates each value. Values display in the following sequence with a colon between them: Plan name and Plan Id. -
planningCycleStages: array
Planning Cycle Stages
Title:
Planning Cycle Stages
A review stage represents the activities, tasks, and participants in a recurring planning process. For example, Demand Review and Supply Review are stages in a sales and operations planning process -
PlanningCycleStagesDetail: string
Read Only:
true
Maximum Length:4000
List of stages in the planning cycle. A comma separates each value. Values display in the following sequence with a colon between them: Stage Name and Display Order. -
PlanningCycleStartDate: string
(date)
Date when the planning cycle starts.
-
PlanningCycleStatus: string
Read Only:
true
Maximum Length:255
Status name of the planning cycle. Contains one of the following names. Not started, In progress, or Completed. -
PlanningCycleStatusCode: integer
(int32)
Status of the planning cycle. Contains one of the following values. 0: Not started, 1: In progress, or 2: Completed.
-
planningCycleWorkLists: array
Planning Cycle Worklists
Title:
Planning Cycle Worklists
A worklist is a list of planning tasks that require user action.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Planning Cycle Plans
Type:
array
Title:
Planning Cycle Plans
A planning cycle has one or more linked supply chain plans to analyze. For example, you can include the current baseline plan and alternative plans in the planning cycle. The links that you set up for an activity or task opens reports in the plans.
Show Source
Nested Schema : Planning Cycle Stages
Type:
array
Title:
Planning Cycle Stages
A review stage represents the activities, tasks, and participants in a recurring planning process. For example, Demand Review and Supply Review are stages in a sales and operations planning process
Show Source
Nested Schema : Planning Cycle Worklists
Type:
array
Title:
Planning Cycle Worklists
A worklist is a list of planning tasks that require user action.
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 : planningCycles-planningCyclePlans-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who added the plan to the planning cycle stage. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user added the plan to the planning cycle stage. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the plan in the planning cycle stage. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the plan in the planning cycle stage. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PlanningCycleId: integer
(int64)
Value that uniquely identifies the planning cycle associated with the plan.
-
PlanningCyclePlansPlanId: integer
(int64)
Value that uniquely identifies the plan associated with the planning cycle.
-
PlanningCyclePlansPlanName: string
Maximum Length:
30
Name of the plan associated with the planning cycle.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : planningCycles-planningCycleStages-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the planning cycle stage. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the planning cycle stage. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the planning cycle stage. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the planning cycle stage. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
planningCycleActionDecisionItems: array
Action and Decision Items
Title:
Action and Decision Items
An action item is an unplanned task assigned in a planning cycle stage. A decision item is a recommendation or an alternative to consider during a review stage meeting. -
planningCycleActivities: array
Activities
Title:
Activities
An activity is a group of related planning tasks in a planning cycle stage. -
PlanningCycleId: integer
(int64)
Value that uniquely identifies the planning cycle.
-
planningCycleParticipants: array
Participants
Title:
Participants
A group of users to assign tasks as owners and assignees in a planning cycle stage. -
PlanningCycleStageDisplayOrder: integer
(int32)
Value that indicates the display order of the stage in the planning cycle.
-
PlanningCycleStageId: integer
(int64)
Value that uniquely identifies the planning cycle stage.
-
PlanningCycleStageName: string
Maximum Length:
256
Name of the planning cycle stage.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Action and Decision Items
Type:
array
Title:
Action and Decision Items
An action item is an unplanned task assigned in a planning cycle stage. A decision item is a recommendation or an alternative to consider during a review stage meeting.
Show Source
Nested Schema : Activities
Type:
array
Title:
Activities
An activity is a group of related planning tasks in a planning cycle stage.
Show Source
Nested Schema : Participants
Type:
array
Title:
Participants
A group of users to assign tasks as owners and assignees in a planning cycle stage.
Show Source
Nested Schema : planningCycles-planningCycleStages-planningCycleActionDecisionItems-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the action and decision item in the planning cycle stage. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the action and decision item in the planning cycle stage. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the action and decision item in the planning cycle stage. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the action and decision item in the planning cycle stage. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PlanningCycleTaskAssignee: string
Read Only:
true
Maximum Length:255
Name of the user who's assigned the action and decision item in the planning cycle stage. -
PlanningCycleTaskAssigneeId: string
Maximum Length:
64
Value that uniquely identifies who's assigned the action and decision item in the planning cycle stage. -
PlanningCycleTaskComments: string
Maximum Length:
1000
Description of the planning cycle. -
PlanningCycleTaskCompletionDate: string
(date)
Date when the action and decision item in the planning cycle stage is completed.
-
PlanningCycleTaskDaysLate: integer
Read Only:
true
Value that indicates the difference between the completion date and the due date for the action and decision item in the planning cycle stage. -
PlanningCycleTaskDueDate: string
(date)
Date when the action and decision item in the planning cycle stage is due.
-
PlanningCycleTaskId: integer
(int64)
Value that uniquely identifies the action and decision item in the planning cycle stage.
-
PlanningCycleTaskLink: string
Maximum Length:
256
Name of the report link associated with the action and decision item in the planning cycle stage. -
PlanningCycleTaskLinkId: integer
(int64)
Value that uniquely identifies the report link associated with the action and decision item in the planning cycle stage.
-
PlanningCycleTaskLinkType: integer
(int32)
Type of report link associated with the action and decision item task in the planning cycle stage. A valid value includes 2 for page group.
-
PlanningCycleTaskOffSetDays: integer
(int64)
Value that specifies the task due date relative to the start of the planning cycle. For example, a value of 10 indicates the task is due 10 days after the start of the planning cycle.
-
PlanningCycleTaskOwner: string
Read Only:
true
Maximum Length:255
Name of the user who owns the action and decision item in the planning cycle stage. -
PlanningCycleTaskOwnerId: string
Maximum Length:
64
Value that uniquely identifies who owns the action and decision item in the planning cycle stage. -
PlanningCycleTaskStageId: integer
(int64)
Value that uniquely identifies the planning cycle stage associated with the action and decision item.
-
PlanningCycleTaskStageName: string
Read Only:
true
Maximum Length:256
Name of the planning cycle stage associated with the action and decision item. -
PlanningCycleTaskStatus: string
Read Only:
true
Maximum Length:80
Status name of the action and decision item in the planning cycle stage. A list of valid names for the action item is defined in the lookup type ORA_MSC_SOP_TASK_STATUS. A list of valid status names for the decision item is defined in the lookup type ORA_MSC_SOP_RECOMMEND_STATUS. -
PlanningCycleTaskStatusCode: string
Maximum Length:
32
Status of the action and decision item in the planning cycle stage. A list of valid values for the action item is defined in the lookup type ORA_MSC_SOP_TASK_STATUS. A list of valid values for the decision item is defined in the lookup type ORA_MSC_SOP_RECOMMEND_STATUS. -
PlanningCycleTaskTitle: string
Maximum Length:
100
Name of the action and decision item in the planning cycle stage. -
PlanningCycleTaskType: string
Read Only:
true
Maximum Length:80
Name of the type of action and decision item in the planning cycle stage. Contains one of the following names. Action or Decision. -
PlanningCycleTaskTypeCode: string
Maximum Length:
64
Type of action and decision item in the planning cycle stage. Contains one of the following values. 1: Action or 2: Decision.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : planningCycles-planningCycleStages-planningCycleActivities-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the activity in the planning cycle stage. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the activity in the planning cycle stage. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the activity in the planning cycle stage. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the activity in the planning cycle stage. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PlanningCycleActivityAssigneeId: string
Maximum Length:
64
Value that uniquely identifies who's assigned the activity in the planning cycle stage. -
PlanningCycleActivityAssigneeName: string
Read Only:
true
Maximum Length:255
Name of the user who's assigned the activity in the planning cycle stage. -
PlanningCycleActivityCompletionDate: string
(date)
Date when the activity in the planning cycle stage is completed.
-
PlanningCycleActivityDaysLate: integer
Read Only:
true
Value that indicates the difference between the completion date and the due date for the activity in the planning cycle stage. -
PlanningCycleActivityDescription: string
Maximum Length:
256
Description of the activity in the planning cycle stage. -
PlanningCycleActivityDisplayOrder: integer
(int64)
Value that indicates the display order of the activity in the planning cycle stage.
-
PlanningCycleActivityDueDate: string
(date)
Date when the activity in the planning cycle stage is due.
-
PlanningCycleActivityId: integer
(int64)
Value that uniquely identifies the activity in the planning cycle stage.
-
PlanningCycleActivityLink: string
Maximum Length:
256
Name of the report link associated with the activity in the planning cycle stage. -
PlanningCycleActivityLinkId: integer
(int64)
Value that uniquely identifies the report link associated with the activity in the planning cycle stage.
-
PlanningCycleActivityLinkType: integer
(int32)
Type of report link associated with the activity in the planning cycle stage. A valid value includes 2 for page group.
-
PlanningCycleActivityName: string
Maximum Length:
256
Name of the activity in the planning cycle stage. -
PlanningCycleActivityOwnerId: string
Maximum Length:
64
Value that uniquely identifies who owns the activity in the planning cycle stage. -
PlanningCycleActivityOwnerName: string
Read Only:
true
Maximum Length:255
Name of the user who owns the activity in the planning cycle stage. -
PlanningCycleActivityStageId: integer
(int64)
Value that uniquely identifies the planning cycle stage associated with the activity.
-
PlanningCycleActivityStageName: string
Read Only:
true
Maximum Length:256
Name of the planning cycle stage associated with the activity. -
PlanningCycleActivityStatus: string
Read Only:
true
Maximum Length:80
Status name of the activity in the planning cycle stage derived from its tasks. A list of valid names for the activity is defined in the lookup type ORA_MSC_SOP_TASK_STATUS. -
PlanningCycleActivityStatusCode: string
Maximum Length:
32
Status of the activity in the planning cycle stage derived from its tasks. A list of valid values for the activity is defined in the lookup type ORA_MSC_SOP_TASK_STATUS. -
PlanningCycleActivityType: string
Maximum Length:
80
Name of the type of activity in the planning cycle stage. A list of valid names for the activity is defined in the lookup type ORA_MSC_SOP_ACTIVITY_TASK_TYPE. -
PlanningCycleActivityTypeCode: string
Maximum Length:
64
Type of activity in the planning cycle stage. A list of valid values for the activity is defined in the lookup type ORA_MSC_SOP_ACTIVITY_TASK_TYPE. -
planningCycleTasks: array
Tasks
Title:
Tasks
A recurring task that has an owner and an assignee in a planning cycle stage.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Tasks
Type:
array
Title:
Tasks
A recurring task that has an owner and an assignee in a planning cycle stage.
Show Source
Nested Schema : planningCycles-planningCycleStages-planningCycleActivities-planningCycleTasks-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the task in the planning cycle stage. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the task in the planning cycle stage. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the task in the planning cycle stage. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the task in the planning cycle stage. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PlanningCycleTaskAssignee: string
Read Only:
true
Maximum Length:255
Name of the user who's assigned the task in the planning cycle stage. -
PlanningCycleTaskAssigneeId: string
Maximum Length:
64
Value that uniquely identifies who's assigned the task in the planning cycle stage. -
PlanningCycleTaskCompletionDate: string
(date)
Date when the task in the planning cycle stage is completed.
-
PlanningCycleTaskDaysLate: integer
Read Only:
true
Value that indicates the difference between the completion date and the due date for the task in the planning cycle stage. -
PlanningCycleTaskDueDate: string
(date)
Date when the task in the planning cycle stage is due.
-
PlanningCycleTaskId: integer
(int64)
Value that uniquely identifies the task in the planning cycle stage.
-
PlanningCycleTaskLinkId: integer
(int64)
Value that uniquely identifies the report link associated with the task in the planning cycle stage.
-
PlanningCycleTaskLinktype: integer
(int32)
Type of report link associated with the task in the planning cycle stage. A valid value includes 2 for page group.
-
PlanningCycleTaskOffSetDays: integer
(int64)
Value that specifies the task due date relative to the start of the planning cycle. For example, a value of 10 indicates the task is due 10 days after the start of the planning cycle.
-
PlanningCycleTaskOwner: string
Read Only:
true
Maximum Length:255
Name of the user who owns the task in the planning cycle stage. -
PlanningCycleTaskOwnerId: string
Maximum Length:
64
Value that uniquely identifies who owns the task in the planning cycle stage. -
PlanningCycleTaskStageId: integer
(int64)
Value that uniquely identifies the planning cycle stage associated with the task.
-
PlanningCycleTaskStageName: string
Read Only:
true
Maximum Length:256
Name of the planning cycle stage associated with the task. -
PlanningCycleTaskStatus: string
Read Only:
true
Maximum Length:80
Status name of the task in the planning cycle stage. A list of valid names for the task is defined in the lookup type ORA_MSC_SOP_TASK_STATUS. -
PlanningCycleTaskStatusCode: string
Maximum Length:
32
Status of the task in the planning cycle stage. A list of valid values for the task is defined in the lookup type ORA_MSC_SOP_TASK_STATUS. -
PlanningCycleTaskTitle: string
Maximum Length:
100
Name of the task in the planning cycle stage. -
PlanningCycleTaskType: string
Maximum Length:
80
Name of the type of task in the planning cycle stage. A list of valid names for the task is defined in the lookup type ORA_MSC_SOP_ACTIVITY_TASK_TYPE. -
PlanningCycleTaskTypeCode: string
Maximum Length:
64
Type of task in the planning cycle stage. A list of valid values for the task is defined in the lookup type ORA_MSC_SOP_ACTIVITY_TASK_TYPE. -
PlannningCycleTaskLink: string
Maximum Length:
256
Name of the report link associated with the task in the planning cycle stage.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : planningCycles-planningCycleStages-planningCycleParticipants-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who added the participant to the planning cycle stage. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user added the participant to the planning cycle stage. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the participant in the planning cycle stage. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the participant in the planning cycle stage. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PlanningCycleId: integer
(int64)
Value that uniquely identifies the planning cycle in which the user is a participant.
-
PlanningCycleParticipantId: string
Maximum Length:
64
Value that uniquely identifies the user who's a participant in the planning cycle stage. -
PlanningCycleParticipantName: string
Read Only:
true
Maximum Length:255
Name of the user who's a participant in the planning cycle stage. -
PlanningCycleParticipantsStageId: integer
(int64)
Value that uniquely identifies the planning cycle stage in which the user is a participant.
-
PlanningCycleParticipantsStageName: string
Read Only:
true
Maximum Length:256
Name of the planning cycle stage in which the user is a participant.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : planningCycles-planningCycleWorkLists-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the task in the planning cycle worklist. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the task in the planning cycle worklist. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the task in the planning cycle worklist. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the task in the planning cycle worklist. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PlanningCycleId: integer
(int64)
Read Only:
true
Value that uniquely identifies the planning cycle in which the worklist task was added. -
PlanningCycleWorkListActivityId: integer
(int64)
Read Only:
true
Value that uniquely identifies the planning cycle activity. -
PlanningCycleWorkListActivityTitle: string
Read Only:
true
Maximum Length:256
Name of the activity in the planning cycle stage. -
PlanningCycleWorkListAssigneeId: string
Read Only:
true
Maximum Length:64
Value that uniquely identifies who's assigned the task in the planning cycle worklist. -
PlanningCycleWorkListAssigneeName: string
Read Only:
true
Maximum Length:255
Name of the user who's assigned the task in the planning cycle worklist. -
PlanningCycleWorkListComments: string
Read Only:
true
Maximum Length:1000
Description of the planning cycle. -
PlanningCycleWorkListCompletionDate: string
(date)
Read Only:
true
Date when the task in the planning cycle worklist is completed. -
PlanningCycleWorkListDaysLate: integer
Read Only:
true
Value that indicates the difference between the completion date and the due date for the task in the planning cycle worklist. -
PlanningCycleWorkListDueDate: string
(date)
Read Only:
true
Date when the task in the planning cycle worklist is due. -
PlanningCycleWorkListLink: string
Read Only:
true
Maximum Length:256
Name of the report link associated with the task in the planning cycle worklist. -
PlanningCycleWorkListLinkId: integer
(int64)
Read Only:
true
Value that uniquely identifies the report link associated with the task in the worklist. -
PlanningCycleWorkListLinkType: integer
(int32)
Read Only:
true
Type of report link associated with the task in the planning cycle worklist. A valid value includes 2 for page group. -
PlanningCycleWorkListOffSetDays: integer
Read Only:
true
Value that specifies the task due date relative to the start of the planning cycle. For example, a value of 10 indicates the task is due 10 days after the start of the planning cycle. -
PlanningCycleWorkListOwner: string
Read Only:
true
Maximum Length:64
Value that uniquely identifies who owns the task in the planning cycle worklist. -
PlanningCycleWorkListOwnerName: string
Read Only:
true
Maximum Length:255
Name of the user who owns the task in the planning cycle worklist. -
PlanningCycleWorkListStageId: integer
(int64)
Read Only:
true
Value that uniquely identifies the planning cycle stage in which the worklist task was added. -
PlanningCycleWorkListStageName: string
Read Only:
true
Maximum Length:256
Name of the planning cycle stage in which the worklist task was added. -
PlanningCycleWorkListStatus: string
Read Only:
true
Maximum Length:4000
Status name of the task, action and decision item in the planning cycle worklist. A list of valid names for the task and action item is defined in the lookup type ORA_MSC_SOP_TASK_STATUS. A list of valid status names for the decision item is defined in the lookup type ORA_MSC_SOP_RECOMMEND_STATUS. -
PlanningCycleWorkListStatusCode: string
Read Only:
true
Maximum Length:128
Status of the task, action and decision item in the planning cycle worklist. A list of valid values for the task and action item is defined in the lookup type ORA_MSC_SOP_TASK_STATUS. A list of valid values for the decision item is defined in the lookup type ORA_MSC_SOP_RECOMMEND_STATUS. -
PlanningCycleWorkListTaskId: integer
Read Only:
true
Value that uniquely identifies the task in the planning cycle worklist. -
PlanningCycleWorkListTaskType: string
Read Only:
true
Maximum Length:256
Name of the type of task in the planning cycle worklist. A list of valid names for the task is defined in the lookup type ORA_MSC_SOP_ACTIVITY_TASK_TYPE. -
PlanningCycleWorkListTitle: string
Read Only:
true
Maximum Length:256
Name of the task in the planning cycle worklist.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- planningCyclePlans
-
Operation: /fscmRestApi/resources/11.13.18.05/planningCycles/{PlanningCycleId}/child/planningCyclePlansParameters:
- PlanningCycleId:
$request.path.PlanningCycleId
A planning cycle has one or more linked supply chain plans to analyze. For example, you can include the current baseline plan and alternative plans in the planning cycle. The links that you set up for an activity or task opens reports in the plans. - PlanningCycleId:
- planningCycleStages
-
Operation: /fscmRestApi/resources/11.13.18.05/planningCycles/{PlanningCycleId}/child/planningCycleStagesParameters:
- PlanningCycleId:
$request.path.PlanningCycleId
A review stage represents the activities, tasks, and participants in a recurring planning process. For example, Demand Review and Supply Review are stages in a sales and operations planning process - PlanningCycleId:
- planningCycleWorkLists
-
Operation: /fscmRestApi/resources/11.13.18.05/planningCycles/{PlanningCycleId}/child/planningCycleWorkListsParameters:
- PlanningCycleId:
$request.path.PlanningCycleId
A worklist is a list of planning tasks that require user action. - PlanningCycleId: