Get all operations

get

/fscmRestApi/resources/11.13.18.05/simulationSets/{SimulationSetId}/child/Operations

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 routing operation using the primary key.
      Finder Variables
      • NewPlanId; integer; Value that uniquely identifies the new plan that the duplication process creates.
      • NewPlanIdSecondary; integer; Value that uniquely identifies the new plan that the duplication process creates.
      • OperationSequenceId; integer; Value that uniquely identifies the operation sequence.
      • OrganizationId; integer; Value that uniquely identifies the organization.
      • OrganizationIdSecondary; integer; Unique identifier of the organization.
      • PlanId; integer; Value that uniquely identifies the plan.
      • PlanIdSecondary; integer; Value that uniquely identifies the plan.
      • RoutingSequenceId; integer; Routing sequence identifier for the routing or the work definition.
      • RoutingSequenceIdSecondary; integer; Routing sequence identifier for the routing or the work definition.
      • SimulationSetId; integer; Value that uniquely identifies the simulation set.
      • SimulationSetIdSecondary; integer; Value that uniquely identifies the simulation set.
  • 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:
    • ChangeIndicatorFlag; boolean; Value that identifies whether the work definition operation has been modified. Valid values are true or false. If true, then the row is new or modified. If false, then the row isn't new or modified.
    • FixedLeadTime; number; Days required to produce a batch of an assembled item.
    • Item; string; Name of the item being made in the operation.
    • ItemId; integer; Value that uniquely identifies the item.
    • LastUpdateDate; string; Indicates the date and time of the last update of the row.
    • LastUpdatedBy; string; Indicates the user who last updated the row.
    • LineCode; string; Code for the production line represents a collection of machines and assembly workstations used to manufacture a product or a group of products.
    • LineOperationSequence; integer; Stage where the material is consumed on a production line.
    • LineRate; number; Hourly rate of the production line.
    • MinimumTransferQuantity; number; Minimum amount of a supply to be transferred.
    • NewPlanId; integer; Value that uniquely identifies the new plan that the duplication process creates.
    • NewPlanIdSecondary; integer; Value that uniquely identifies the new plan that the duplication process creates.
    • NotesCount; integer; Number of notes associated with this operation.
    • NumberOfLineOperations; integer; Identifies the number of operations on a production line.
    • OperationCost; number; Value that indicates the outside processing operation cost.
    • OperationDescription; string; Operation Description
    • OperationEffectiveEndDate; string; Operation Effective End Date
    • OperationEffectiveStartDate; string; Operation Effective Start Date
    • OperationSequenceId; integer; Unique identifier of the operation sequence.
    • OperationSequenceNumber; integer; Number that identifies the execution sequence of the operation.
    • OperationType; string; Operation Type
    • OperationYield; number; Operation Yield
    • OrganizationCode; string; Indicates the organization identifier.
    • OrganizationId; integer; Unique identifier of the organization.
    • OrganizationIdSecondary; integer; Unique identifier of the organization.
    • PlanId; integer; Value that uniquely identifies the plan.
    • PlanIdSecondary; integer; Value that uniquely identifies the plan.
    • PlanningPercentage; number; Percentage of time a component item or option will be used within a parent model or a product family.
    • Primary; string; Indicates whether the related object is the primary object. For example, whether a routing is the primary routing.
    • ProcessName; string; Name of the work definition process.
    • RoutingSequenceId; integer; Routing sequence identifier for the routing or the work definition.
    • RoutingSequenceIdSecondary; integer; Routing sequence identifier for the routing or the work definition.
    • SimulationSetId; integer; Value that uniquely identifies the simulation set.
    • SimulationSetIdSecondary; integer; Value that uniquely identifies the simulation set.
    • Supplier; string; Name of the supplier in the demand exception.
    • SupplierId; integer; Value that uniquely identifies the supplier.
    • SupplierSite; string; Name of the supplier site in the demand exception.
    • SupplierSiteId; integer; Value that uniquely identifies the supplier site in the demand exception.
    • VariableLeadTime; number; Days required to produce one unit of an assembled item that will be incurred for each item being made.
    • WorkDefinitionDescription; string; Description of a work definition for an item.
    • WorkDefinitionName; string; Work Definition
    • WorkMethod; string; Type of manufacturing used for the production process. Valid values are Discrete Manufacturing and Process Manufacturing.
  • 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 : simulationSets-Operations
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : simulationSets-Operations-item-response
Type: object
Show Source
Nested Schema : Operation Resources
Type: array
Title: Operation Resources
Resources, such as equipment and labor, required in each operation to make an item.
Show Source
Nested Schema : simulationSets-Operations-OperationResources-item-response
Type: object
Show Source
Back to Top