Get all operations
get
/fscmRestApi/resources/11.13.18.05/simulationSets/{SimulationSetId}/child/Operations
Request
Path Parameters
-
SimulationSetId(required): integer(int64)
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
-
dependency: string
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> -
expand: string
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).
-
fields: string
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 -
finder: string
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.
- PrimaryKey Finds the routing operation using the primary key.
-
limit: integer
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.
-
links: string
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 -
offset: integer
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.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
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
-
q: string
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.
-
totalResults: boolean
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
-
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.
There's no request body for this operation.
Back to TopResponse
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 : simulationSets-Operations
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : simulationSets-Operations-item-response
Type:
Show Source
object
-
ChangeIndicatorFlag: boolean
Read Only:
true
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
Title:
Fixed Lead Time
Days required to produce a batch of an assembled item. -
Item: string
Title:
Item
Maximum Length:250
Name of the item being made in the operation. -
ItemId: integer
(int64)
Value that uniquely identifies the item.
-
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Indicates the date and time of the last update of the row. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
Indicates the user who last updated the row. -
LineCode: string
Title:
Line Code
Read Only:true
Maximum Length:120
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
Title:
Line Operation Sequence
Read Only:true
Stage where the material is consumed on a production line. -
LineRate: number
Title:
Line Rate
Read Only:true
Hourly rate of the production line. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MinimumTransferQuantity: number
Title:
Minimum Transfer Quantity
Minimum amount of a supply to be transferred. -
NewPlanId: integer
(int64)
Value that uniquely identifies the new plan that the duplication process creates.
-
NewPlanIdSecondary: integer
(int64)
Value that uniquely identifies the new plan that the duplication process creates.
-
NotesCount: integer
Title:
Notes
Read Only:true
Number of notes associated with this operation. -
NumberOfLineOperations: integer
Title:
Number of Operations
Read Only:true
Identifies the number of operations on a production line. -
OperationCost: number
Title:
Operation Cost
Value that indicates the outside processing operation cost. -
OperationDescription: string
Title:
Operation Description
Maximum Length:240
Operation Description -
OperationEffectiveEndDate: string
(date)
Title:
Operation Effective End Date
Operation Effective End Date -
OperationEffectiveStartDate: string
(date)
Title:
Operation Effective Start Date
Operation Effective Start Date -
OperationResources: array
Operation Resources
Title:
Operation Resources
Resources, such as equipment and labor, required in each operation to make an item. -
OperationSequenceId: integer
(int64)
Unique identifier of the operation sequence.
-
OperationSequenceNumber: integer
(int64)
Title:
Operation Sequence Number
Number that identifies the execution sequence of the operation. -
OperationType: string
Title:
Operation Type
Maximum Length:80
Operation Type -
OperationYield: number
Title:
Operation Yield
Operation Yield -
OrganizationCode: string
Title:
Organization
Maximum Length:49
Indicates the organization identifier. -
OrganizationId: integer
(int64)
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
Title:
Planning Percentage
Percentage of time a component item or option will be used within a parent model or a product family. -
Primary: string
Title:
Primary
Read Only:true
Maximum Length:255
Indicates whether the related object is the primary object. For example, whether a routing is the primary routing. -
ProcessName: string
Title:
Process Name
Maximum Length:120
Name of the work definition process. -
RoutingSequenceId: integer
Routing sequence identifier for the routing or the work definition.
-
RoutingSequenceIdSecondary: integer
(int64)
Routing sequence identifier for the routing or the work definition.
-
SimulationSetId: integer
(int64)
Value that uniquely identifies the simulation set.
-
SimulationSetIdSecondary: integer
(int64)
Value that uniquely identifies the simulation set.
-
Supplier: string
Title:
Supplier
Read Only:true
Maximum Length:4000
Name of the supplier in the demand exception. -
SupplierId: integer
(int64)
Value that uniquely identifies the supplier.
-
SupplierSite: string
Title:
Supplier Site
Read Only:true
Maximum Length:4000
Name of the supplier site in the demand exception. -
SupplierSiteId: integer
(int64)
Value that uniquely identifies the supplier site in the demand exception.
-
VariableLeadTime: number
Title:
Variable Lead Time
Days required to produce one unit of an assembled item that will be incurred for each item being made. -
WorkDefinitionDescription: string
Title:
Work Definition Description
Maximum Length:960
Description of a work definition for an item. -
WorkDefinitionName: string
Title:
Work Definition
Maximum Length:300
Work Definition -
WorkMethod: string
Title:
Work Method
Read Only:true
Maximum Length:255
Type of manufacturing used for the production process. Valid values are Discrete Manufacturing and Process Manufacturing.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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 : 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 : simulationSets-Operations-OperationResources-item-response
Type:
Show Source
object
-
AlternateResource: string
Title:
Alternate Resource
Read Only:true
Maximum Length:255
Indicates whether the resource is an alternate, nonprimary resource. Value values are Yes and No. -
AssignedUnits: integer
Title:
Assigned Units
Number of units assigned to a resource. -
Basis: string
Title:
Basis
Read Only:true
Maximum Length:255
Identifies whether component item usage is based on the quantity of an item produced or for the entire lot. -
BasisCode: integer
Title:
Basis
Identifies whether component item usage is based on the quantity of an item produced or for the entire lot. -
ChangeIndicatorFlag: boolean
Read Only:
true
Value that identifies whether the operation description 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. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
Indicates the user who last updated the row. -
LastUpdatedDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Indicates the date and time of the last update of the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NewPlanId: integer
(int64)
Value that uniquely identifies the new plan that the duplication process creates.
-
NewPlanIdSecondary: integer
(int64)
Value that uniquely identifies the new plan that the duplication process creates.
-
OperationSequenceId: integer
Unique identifier of the operation sequence.
-
OperationSequenceIdSecondary: integer
Unique identifier of the operation sequence.
-
OrganizationId: integer
(int64)
Unique identifier of the organization.
-
OrganizationIdSecondary: integer
(int64)
Unique identifier of the organization.
-
PlanId: integer
Value that uniquely identifies the plan.
-
PlanIdSecondary: integer
Value that uniquely identifies the plan.
-
PrimaryResource: string
Title:
Primary Resource
Maximum Length:40
Name of the primary resource for which a specific resource is an alternate. -
PrimaryResourceId: integer
(int64)
Title:
Primary Resource
Unique identifier of the primary resource for which a specific resource is an alternate. -
PrincipalResource: string
Title:
Principal Resource
Read Only:true
Maximum Length:255
Indicates whether a resource is a main resource or not. Valid Values are Yes and No. -
Priority: integer
Title:
Priority
A numeric value indicating the priority of the object. -
Resource: string
Title:
Resource
Maximum Length:72
Code used to identify a resource. For example, a resource can be a piece of equipment. -
ResourceCost: number
Title:
Resource Cost
Cost associated with a resource. -
ResourceId: integer
(int64)
Value that uniquely identifies the resource.
-
ResourceSequence: integer
Title:
Resource Sequence
Number representing the order in which the resources are assigned in the same operation. -
ResourceSequenceSecondary: integer
(int64)
Number representing the order in which the resources are assigned in the same operation.
-
ResourceUOM: string
Title:
Resource UOM
Read Only:true
Maximum Length:4000
Unit of measure associated with the resource. -
RoutingSequenceId: integer
Routing sequence identifier for the routing or the work definition.
-
RoutingSequenceIdSecondary: integer
Routing sequence identifier for the routing or the work definition.
-
ScheduleType: string
Title:
Schedule Type
Maximum Length:80
Indicates whether the resource needs to be scheduled or not. Valid values are Yes and No. -
SimulationSetId: integer
(int64)
Value that uniquely identifies the simulation set.
-
SimulationSetIdSecondary: integer
(int64)
Value that uniquely identifies the simulation set.
-
Usage: number
Title:
Usage
Amount of a resource that's needed, usually expressed in hours. -
WorkArea: string
Title:
Work Area
Maximum Length:120
Name of the work area. -
WorkCenter: string
Title:
Work Center
Maximum Length:120
Work center name of the resource.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source