Get one production schedule

get

/fscmRestApi/resources/11.13.18.05/productionSchedulingPlans/{PlanId}

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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
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 : productionSchedulingPlans-item-response
Type: object
Show Source
Nested Schema : Assets
Type: array
Title: Assets
The Assets resource manages the assets that require maintenance.
Show Source
Nested Schema : Assigned Attribute Values
Type: array
Title: Assigned Attribute Values
The Assigned Attribute Values resource manages the attributes that are assigned to work order operations that are used for scheduling.
Show Source
Nested Schema : Attributes
Type: array
Title: Attributes
The Attributes resource manages the attributes that are a part of the plan that are used for scheduling.
Show Source
Nested Schema : Calendar Events
Type: array
Title: Calendar Events
The Calendar Events resource manages the specific events on a calendar that indicates what time a resource is available.
Show Source
Nested Schema : Calendars
Type: array
Title: Calendars
The Calendars resource manages the calendars that are part of the schedule to establish availability.
Show Source
Nested Schema : Changeover Instances
Type: array
Title: Changeover Instances
The Changeover Instances resource manages the individual changeover instances that occur on a production resource as a result of the changeover rules.
Show Source
Nested Schema : Changeover Rules
Type: array
Title: Changeover Rules
The Changeover Rules resource manages the changeover rules by attribute for a production resource or group.
Show Source
Nested Schema : KPI for Changeover Times
Type: array
Title: KPI for Changeover Times
The KPI for Changeover Times resource manages the key performance indicator for changeover times of the production schedule used for reporting.
Show Source
Nested Schema : Demand Events
Type: array
Title: Demand Events
The Demand Events resource manages the demands to be considered in the production schedule.
Show Source
Nested Schema : Items
Type: array
Title: Items
The Items resource manages the items that are part of the schedule and can include purchased, manufactured, and finished good items.
Show Source
Nested Schema : KPI for Late Demands
Type: array
Title: KPI for Late Demands
The KPI for Late Demands resource manages the key performance indicator for late demands of the production schedule used for reporting.
Show Source
Nested Schema : KPI for Late Work Orders
Type: array
Title: KPI for Late Work Orders
The KPI for Late Work Orders resource manages the key performance indicator for late work orders of the production schedule used for reporting.
Show Source
Nested Schema : Pegging Relationships
Type: array
Title: Pegging Relationships
The Pegging Relationships resource manages the pegging between different types of supply and demand.
Show Source
Nested Schema : Plan Statuses
Type: array
Title: Plan Statuses
The Plan Statuses resource manages the different states of the schedule and determines when the schedule is completed.
Show Source
Nested Schema : Reservations
Type: array
Title: Reservations
The Reservations resource manages the reservations in a schedule.
Show Source
Nested Schema : Resource Calendars
Type: array
Title: Resource Calendars
The Resource Calendars resource manages the association of the calendar to the production resource.
Show Source
Nested Schema : Resource Changeover Sequences
Type: array
Title: Resource Changeover Sequences
The Resource Changeover Sequences resource manages the changeover sequences for a production resource.
Show Source
Nested Schema : Resource Groups
Type: array
Title: Resource Groups
The Resource Groups resource manages the user-defined groups of resources.
Show Source
Nested Schema : Resource Group Utilization
Type: array
Title: Resource Group Utilization
The Resource Group Utilization resource manages the resource utilization of a production resource group.
Show Source
Nested Schema : Resource Operation Sequences
Type: array
Title: Resource Operation Sequences
The Resource Operation Sequences resource manages the sequence of operations that occur on a production resource.
Show Source
Nested Schema : Resource Relationships
Type: array
Title: Resource Relationships
The Resource Relationships resource manages the upstream and downstream production resource relationships that describe how a product can be manufactured in a multistage production environment.
Show Source
Nested Schema : Resources
Type: array
Title: Resources
The Resources resource manages production resources that are part of the production schedule.
Show Source
Nested Schema : Resource Usage Levels
Type: array
Title: Resource Usage Levels
The Resource Usage Levels resource manages the usage levels for a production resource.
Show Source
Nested Schema : Resource Utilization
Type: array
Title: Resource Utilization
The Resource Utilization resource manages the resource utilization of a production resource.
Show Source
Nested Schema : KPIs for Resource Utilization
Type: array
Title: KPIs for Resource Utilization
The KPI for Resource Utilization resource manages the summary of the overall utilization of the production resources that are included in the schedule and used for reporting.
Show Source
Nested Schema : KPI Summaries
Type: array
Title: KPI Summaries
The KPI Summaries resource manages the summary of the overall key performance indicators of the production schedule used for reporting.
Show Source
Nested Schema : Scheduling Resources
Type: array
Title: Scheduling Resources
The Scheduling Resources resource manages the production resources used in the production schedule.
Show Source
Nested Schema : Selected Item Categories
Type: array
Title: Selected Item Categories
The Selected Item Categories resource manages the item categories used to establish the scope of items to include in the production schedule.
Show Source
Nested Schema : Supply Events
Type: array
Title: Supply Events
The Supply Events resource manages the supplies that are a part of the production schedule and can include purchase orders, transfer orders, and on hand.
Show Source
Nested Schema : Work Order Operation Alternate Resources
Type: array
Title: Work Order Operation Alternate Resources
The Work Order Operation Alternate Resources resource manages the viable alternate production resource that can be used for an operation.
Show Source
Nested Schema : Work Order Operation Attributes
Type: array
Title: Work Order Operation Attributes
The Work Order Operation Attributes resource manages the attributes that are relevant for a work order operation and used to generate a production schedule.
Show Source
Nested Schema : Work Order Operations
Type: array
Title: Work Order Operations
The Operations resource manages the operations that are a part of the work definition.
Show Source
Nested Schema : Work Orders
Type: array
Title: Work Orders
The Work Orders resource manages the work orders that are to be scheduled in the production schedule.
Show Source
Nested Schema : Work Order Temporal Relations
Type: array
Title: Work Order Temporal Relations
The Work Order Temporal Relations resource manages the temporal relations between the upstream and downstream operations.
Show Source
Nested Schema : productionSchedulingPlans-assets-item-response
Type: object
Show Source
  • Read Only: true
    Value that uniquely identifies the asset charge. This attribute is read only.
  • Read Only: true
    Maximum Length: 80
    Number that uniquely identifies the asset.
  • Read Only: true
    Maximum Length: 64
    User who created the record.
  • Read Only: true
    Date and time when the user created the record.
  • Read Only: true
    Maximum Length: 240
    Description of the asset that the user defines. It can describe the features, characteristics, and so on of the asset.
  • Read Only: true
    Maximum Length: 300
    Abbreviation that uniquely identifies the item that the asset references. The application determines this value from the attribute that identifies the item. This attribute is read only.
  • Read Only: true
    Value that uniquely identifies the item that the asset references.
  • Read Only: true
    Date and time when the user most recently updated the record.
  • Read Only: true
    Maximum Length: 64
    User who most recently updated the record.
  • Read Only: true
    Maximum Length: 32
    Login that the user used when updating the record.
  • Links
  • Read Only: true
    Value that uniquely identifies the production schedule.
  • Read Only: true
    Maximum Length: 80
    Number that uniquely identifies the serial that the asset references. This attributes is applied when the item is serial controlled.
Nested Schema : productionSchedulingPlans-assignedAttributeValues-item-response
Type: object
Show Source
Nested Schema : productionSchedulingPlans-attributes-item-response
Type: object
Show Source
Nested Schema : Attribute Values
Type: array
Title: Attribute Values
The Attribute Values resource manages the attribute values that are used in the scheduling changeover rules.
Show Source
Nested Schema : productionSchedulingPlans-attributes-attributeValues-item-response
Type: object
Show Source
Nested Schema : productionSchedulingPlans-calendarEvents-item-response
Type: object
Show Source
Nested Schema : productionSchedulingPlans-calendars-item-response
Type: object
Show Source
Nested Schema : Calendar Events
Type: array
Title: Calendar Events
The Calendar Events resource manages the specific events on a calendar that indicates what time a resource is available.
Show Source
Nested Schema : productionSchedulingPlans-calendars-calendarEvents-item-response
Type: object
Show Source
Nested Schema : productionSchedulingPlans-changeoverInstances-item-response
Type: object
Show Source
Nested Schema : Changeover Instance Details
Type: array
Title: Changeover Instance Details
The Changeover Instance Details resource manages the details of the changeovers including the attributes and durations that impact that changeover.
Show Source
Nested Schema : productionSchedulingPlans-changeoverInstances-changeoverInstanceDetails-item-response
Type: object
Show Source
Nested Schema : productionSchedulingPlans-changeoverRules-item-response
Type: object
Show Source
Nested Schema : productionSchedulingPlans-changeoverTimeMeasures-item-response
Type: object
Show Source
Nested Schema : productionSchedulingPlans-demandEvents-item-response
Type: object
Show Source
Nested Schema : productionSchedulingPlans-items-item-response
Type: object
Show Source
Nested Schema : On Hold Lots
Type: array
Title: On Hold Lots
The On Hold Lots resource manages the on-hand inventory that's on hold.
Show Source
Nested Schema : productionSchedulingPlans-items-onHoldLots-item-response
Type: object
Show Source
Nested Schema : productionSchedulingPlans-lateDemandMeasures-item-response
Type: object
Show Source
Nested Schema : productionSchedulingPlans-lateWorkOrderMeasures-item-response
Type: object
Show Source
Nested Schema : productionSchedulingPlans-peggingRelationships-item-response
Type: object
Show Source
Nested Schema : productionSchedulingPlans-planStatus-item-response
Type: object
Show Source
Nested Schema : Plan Status Details
Type: array
Title: Plan Status Details
The Plan Status Details resource manages the details of the different states of the schedule.
Show Source
Nested Schema : productionSchedulingPlans-planStatus-planStatusDetails-item-response
Type: object
Show Source
Nested Schema : productionSchedulingPlans-reservations-item-response
Type: object
Show Source
Nested Schema : productionSchedulingPlans-resourceCalendars-item-response
Type: object
Show Source
Nested Schema : productionSchedulingPlans-resourceChangeoverSequences-item-response
Type: object
Show Source
Nested Schema : productionSchedulingPlans-resourceGroups-item-response
Type: object
Show Source
Nested Schema : Resource Group Members
Type: array
Title: Resource Group Members
The Resource Group Members resource manages the resources associated with a resource group.
Show Source
Nested Schema : productionSchedulingPlans-resourceGroups-groupMembers-item-response
Type: object
Show Source
Nested Schema : productionSchedulingPlans-resourceGroupUtilization-item-response
Type: object
Show Source
Nested Schema : productionSchedulingPlans-resourceOperationSequences-item-response
Type: object
Show Source
Nested Schema : productionSchedulingPlans-resourceRelationships-item-response
Type: object
Show Source
Nested Schema : productionSchedulingPlans-resources-item-response
Type: object
Show Source
Nested Schema : Usage Levels
Type: array
Title: Usage Levels
The Usage Levels resource manages the usage levels for a production resource.
Show Source
Nested Schema : productionSchedulingPlans-resources-usageLevels-item-response
Type: object
Show Source
Nested Schema : productionSchedulingPlans-resourceUsageLevels-item-response
Type: object
Show Source
Nested Schema : productionSchedulingPlans-resourceUtilization-item-response
Type: object
Show Source
Nested Schema : productionSchedulingPlans-resourceUtilizationMeasures-item-response
Type: object
Show Source
Nested Schema : productionSchedulingPlans-scheduleMeasures-item-response
Type: object
Show Source
Nested Schema : productionSchedulingPlans-schedulingResources-item-response
Type: object
Show Source
Nested Schema : productionSchedulingPlans-selectedItemCategories-item-response
Type: object
Show Source
Nested Schema : productionSchedulingPlans-supplyEvents-item-response
Type: object
Show Source
Nested Schema : productionSchedulingPlans-workOrderOperationAlternateResources-item-response
Type: object
Show Source
Nested Schema : productionSchedulingPlans-workOrderOperationAttributes-item-response
Type: object
Show Source
Nested Schema : productionSchedulingPlans-workOrderOperations-item-response
Type: object
Show Source
Nested Schema : Operation Materials
Type: array
Title: Operation Materials
The Operation Materials resource manages the items that are either produced or consumed during the manufacturing production process.
Show Source
Nested Schema : Operation Resources
Type: array
Title: Operation Resources
The Operation Resources resource manages the production resources that are used for a particular operation.
Show Source
Nested Schema : productionSchedulingPlans-workOrderOperations-operationMaterials-item-response
Type: object
Show Source
Nested Schema : productionSchedulingPlans-workOrderOperations-operationResources-item-response
Type: object
Show Source
Nested Schema : productionSchedulingPlans-workOrders-item-response
Type: object
Show Source
Nested Schema : Demands
Type: array
Title: Demands
Demands and customers pegged to a work order.
Show Source
Nested Schema : Work Order Operations
Type: array
Title: Work Order Operations
The Operations resource manages the operations that are a part of the work definition.
Show Source
Nested Schema : productionSchedulingPlans-workOrders-demands-item-response
Type: object
Show Source
Nested Schema : productionSchedulingPlans-workOrders-operations-item-response
Type: object
Show Source
Nested Schema : Operation Materials
Type: array
Title: Operation Materials
The Operation Materials resource manages the items that are either produced or consumed during the manufacturing production process.
Show Source
Nested Schema : Operation Resources
Type: array
Title: Operation Resources
The Operation Resources resource manages the production resources that are used for a particular operation.
Show Source
Nested Schema : productionSchedulingPlans-workOrders-operations-operationMaterials-item-response
Type: object
Show Source
Nested Schema : productionSchedulingPlans-workOrders-operations-operationResources-item-response
Type: object
Show Source
Nested Schema : productionSchedulingPlans-workOrderTemporalRelations-item-response
Type: object
Show Source
Back to Top