Get all planning cycles

get

/fscmRestApi/resources/11.13.18.05/planningCycles

Request

Query Parameters
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • Used as a predefined finder to search the collection.

    Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables

    • PrimaryKey Finds planning cycles according to the planning cycle identifier.
      Finder Variables
      • PlanningCycleId; integer; Value that uniquely identifies the planning cycle.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • CreatedBy; string; User who created the planning cycle.
    • CreationDate; string; Date and time when the user created the planning cycle.
    • LastUpdateDate; string; Date and time when the user most recently updated the planning cycle.
    • LastUpdatedBy; string; User who most recently updated the planning cycle.
    • PlanningCycleDescription; string; Description of the planning cycle.
    • PlanningCycleEndDate; string; Date when the planning cycle ends.
    • PlanningCycleId; integer; Value that uniquely identifies the planning cycle.
    • PlanningCycleName; string; Name of the planning cycle.
    • PlanningCycleOwner; string; Name of the user who owns the planning cycle.
    • PlanningCycleOwnerId; string; Value that uniquely identifies who owns the planning cycle.
    • PlanningCyclePlansDetail; string; 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.
    • PlanningCycleStagesDetail; string; 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 when the planning cycle starts.
    • PlanningCycleStatus; string; Status name of the planning cycle. Contains one of the following names. Not started, In progress, or Completed.
    • PlanningCycleStatusCode; integer; Status of the planning cycle. Contains one of the following values. 0: Not started, 1: In progress, or 2: Completed.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • 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".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : planningCycles
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : planningCycles-item-response
Type: object
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 : planningCycles-planningCyclePlans-item-response
Type: object
Show Source
Nested Schema : planningCycles-planningCycleStages-item-response
Type: object
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: object
Show Source
Nested Schema : planningCycles-planningCycleStages-planningCycleActivities-item-response
Type: object
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: object
Show Source
Nested Schema : planningCycles-planningCycleStages-planningCycleParticipants-item-response
Type: object
Show Source
Nested Schema : planningCycles-planningCycleWorkLists-item-response
Type: object
Show Source
Back to Top