Get one operation
get
/fscmRestApi/resources/11.13.18.05/simulationSets/{SimulationSetId}/child/Operations/{OperationsUniqID}
Request
Path Parameters
-
OperationsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- PlanIdSecondary, RoutingSequenceIdSecondary, OrganizationIdSecondary, NewPlanIdSecondary, SimulationSetIdSecondary, PlanId, OperationSequenceId, RoutingSequenceId, OrganizationId, NewPlanId and SimulationSetId ---for the Operations resource and used to uniquely identify an instance of Operations. The client should not generate the hash key value. Instead, the client should query on the Operations collection resource with a filter on the primary key values in order to navigate to a specific instance of Operations.
For example: Operations?q=PlanIdSecondary=<value1>;RoutingSequenceIdSecondary=<value2>;OrganizationIdSecondary=<value3>;NewPlanIdSecondary=<value4>;SimulationSetIdSecondary=<value5>;PlanId=<value6>;OperationSequenceId=<value7>;RoutingSequenceId=<value8>;OrganizationId=<value9>;NewPlanId=<value10>;SimulationSetId=<value11> -
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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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-item-response
Type:
Show Source
object-
ChangeIndicatorFlag: boolean
Read Only:
trueValue 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. -
DataSecurityEditAllowed: string
Read Only:
trueMaximum Length:255Contains one of the following: yes or null. If yes, then the user has data security edit privileges. If null, then the user doesn't have data security edit privileges. -
FixedLeadTime: number
Title:
Fixed Lead TimeDays required to produce a batch of an assembled item. -
Item: string
Title:
ItemMaximum Length:250Name of the item being made in the operation. -
ItemId: integer
(int64)
Value that uniquely identifies the item.
-
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueIndicates the date and time of the last update of the row. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64Indicates the user who last updated the row. -
LineCode: string
Title:
Line CodeRead Only:trueMaximum Length:120Code 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 SequenceRead Only:trueStage where the material is consumed on a production line. -
LineRate: number
Title:
Line RateRead Only:trueHourly rate of the production line. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MinimumTransferQuantity: number
Title:
Minimum Transfer QuantityMinimum 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:
NotesRead Only:trueNumber of notes associated with this operation. -
NumberOfLineOperations: integer
Title:
Number of OperationsRead Only:trueIdentifies the number of operations on a production line. -
OperationCost: number
Title:
Operation CostValue that indicates the outside processing operation cost. -
OperationDescription: string
Title:
Operation DescriptionMaximum Length:240Operation Description -
OperationEffectiveEndDate: string
(date)
Title:
Operation Effective End DateOperation Effective End Date -
OperationEffectiveStartDate: string
(date)
Title:
Operation Effective Start DateOperation Effective Start Date -
OperationResources: array
Operation Resources
Title:
Operation ResourcesResources, 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 NumberNumber that identifies the execution sequence of the operation. -
OperationType: string
Title:
Operation TypeMaximum Length:80Operation Type -
OperationYield: number
Title:
Operation YieldOperation Yield -
OrganizationCode: string
Title:
OrganizationMaximum Length:49Indicates 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 PercentagePercentage of time a component item or option will be used within a parent model or a product family. -
Primary: string
Title:
PrimaryRead Only:trueMaximum Length:255Indicates whether the related object is the primary object. For example, whether a routing is the primary routing. -
ProcessName: string
Title:
Process NameMaximum Length:120Name 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:
SupplierRead Only:trueMaximum Length:4000Name of the supplier in the demand exception. -
SupplierId: integer
(int64)
Value that uniquely identifies the supplier.
-
SupplierSite: string
Title:
Supplier SiteRead Only:trueMaximum Length:4000Name 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 TimeDays required to produce one unit of an assembled item that will be incurred for each item being made. -
WorkDefinitionDescription: string
Title:
Work Definition DescriptionMaximum Length:960Description of a work definition for an item. -
WorkDefinitionName: string
Title:
Work DefinitionMaximum Length:300Work Definition -
WorkMethod: string
Title:
Work MethodRead Only:trueMaximum Length:255Type of manufacturing used for the production process. Valid values are Discrete Manufacturing and Process Manufacturing.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Operation Resources
Type:
arrayTitle:
Operation ResourcesResources, 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 referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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 ResourceRead Only:trueMaximum Length:255Indicates whether the resource is an alternate, nonprimary resource. Value values are Yes and No. -
AssignedUnits: integer
Title:
Assigned UnitsNumber of units assigned to a resource. -
Basis: string
Title:
BasisRead Only:trueMaximum Length:255Identifies whether component item usage is based on the quantity of an item produced or for the entire lot. -
BasisCode: integer
Title:
BasisIdentifies whether component item usage is based on the quantity of an item produced or for the entire lot. -
ChangeIndicatorFlag: boolean
Read Only:
trueValue 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 ByRead Only:trueMaximum Length:64Indicates the user who last updated the row. -
LastUpdatedDate: string
(date-time)
Title:
Last Updated DateRead Only:trueIndicates the date and time of the last update of the row. -
links: array
Links
Title:
LinksThe 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 ResourceMaximum Length:40Name of the primary resource for which a specific resource is an alternate. -
PrimaryResourceId: integer
(int64)
Title:
Primary ResourceUnique identifier of the primary resource for which a specific resource is an alternate. -
PrincipalResource: string
Title:
Principal ResourceRead Only:trueMaximum Length:255Indicates whether a resource is a main resource or not. Valid Values are Yes and No. -
Priority: integer
Title:
PriorityA numeric value indicating the priority of the object. -
Resource: string
Title:
ResourceMaximum Length:72Code used to identify a resource. For example, a resource can be a piece of equipment. -
ResourceCost: number
Title:
Resource CostCost associated with a resource. -
ResourceId: integer
(int64)
Value that uniquely identifies the resource.
-
ResourceSequence: integer
Title:
Resource SequenceNumber 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 UOMRead Only:trueMaximum Length:4000Unit 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 TypeMaximum Length:80Indicates 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:
UsageAmount of a resource that's needed, usually expressed in hours. -
WorkArea: string
Title:
Work AreaMaximum Length:120Name of the work area. -
WorkCenter: string
Title:
Work CenterMaximum Length:120Work center name of the resource.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- OperationResources
-
Parameters:
- OperationsUniqID:
$request.path.OperationsUniqID - SimulationSetId:
$request.path.SimulationSetId
Resources, such as equipment and labor, required in each operation to make an item. - OperationsUniqID: