Get all plan organizations

get

/fscmRestApi/resources/11.13.18.05/planOptions/{PlanId}/child/PlanOrganization

Request

Path Parameters
  • The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • 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 the plan organization according to the value that identifies the plan organization.
      Finder Variables
      • TransactionId; integer; Value that uniquely identifies the plan organization.
  • 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:
    • BillOfResources; string; Label for a list for the Create Bills of Resources scheduled process. The planner can choose for the resource structure to be within a single organization or across multiple organizations.
    • CreatedBy; string; Name of the user who created the plan organization.
    • CreationDate; string; Date when the plan organization was originally created.
    • Description; string; Description for the source system organization.
    • ForecastSpreadingCalendar; string; Calendar used for forecast spreading an aggregate demand plan forecast across multiple time buckets.
    • FrcstSpreadingCalName; string; Name of the calendar used for forecast spreading.
    • IncludeProductionSchedule; number; Indicates whether production schedules are considered in the planning process.
    • IncludeSalesorder; number; Specifies whether sales orders are considered to net from forecasts.
    • LastUpdateDate; string; Date when the user most recently updated the plan.
    • LastUpdateLogin; string; Last time the user logged into the system.
    • LastUpdatedBy; string; User who performed the most recent update on the plan.
    • NetOnHand; number; Net on-hand quantity of an item.
    • NetPurchasing; number; Net purchased quantity of an item.
    • NetReservations; number; Net reserved quantity of an item.
    • NetTransfers; number; Final net on the transfer quantity of an item.
    • NetWIP; number; Net work in process quantity of an item.
    • ObjectVersionNumber; integer; Plan version number.
    • OrganizationCode; string; Short code for the organization.
    • OrganizationId; integer; Unique value that identifies an organization.
    • OrganizationName; string; Name of the organization.
    • ParentOrgId; integer; Identifies the organization selected from a list of values to be the parent for a child organization. Parent and child organizations are modeled for pooling child organization supplies into a parent organization for netting demands. Parent and child modeling for organizations is set up using the Manage Planning Source Systems task.
    • PlanId; integer; Value that uniquely identifies the plan.
    • PlanSafetyStock; number; Plan option that triggers supply plan to calculate safety stock.
    • ProductionScheduleId; integer; Value that uniquely identifies the production schedule.
    • SimulationSet; string; Name of a simulation set. A simulation set consists of adjustments to plan inputs that can be applied to a plan to model different business scenarios, such as increasing available resource capacity.
    • TransactionId; integer; Unique transaction identifier.
  • 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 : planOptions-PlanOrganization
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : planOptions-PlanOrganization-item-response
Type: object
Show Source
Nested Schema : Subinventories
Type: array
Title: Subinventories
The subinventories of a user-selected organization specified in the plan options that are used in the supply planning process, which generates supplies for the subinventories, if needed.
Show Source
Nested Schema : planOptions-PlanOrganization-SubInventory-item-response
Type: object
Show Source
Back to Top