Get one changeover instance
get
/fscmRestApi/resources/11.13.18.05/productionSchedulingPlans/{PlanId}/child/changeoverInstances/{changeoverInstancesUniqID}
Request
Path Parameters
-
PlanId(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=
-
changeoverInstancesUniqID(required): string
This is the hash key of the attributes which make up the composite key--- PlanId and ChangeoverInstanceId ---for the Changeover Instances resource and used to uniquely identify an instance of Changeover Instances. The client should not generate the hash key value. Instead, the client should query on the Changeover Instances collection resource with a filter on the primary key values in order to navigate to a specific instance of Changeover Instances.
For example: changeoverInstances?q=PlanId=<value1>;ChangeoverInstanceId=<value2>
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:
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.
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 : productionSchedulingPlans-changeoverInstances-item-response
Type:
Show Source
object
-
changeoverInstanceDetails: array
Changeover Instance Details
Title:
Changeover Instance Details
The Changeover Instance Details resource manages the details of the changeovers including the attributes and durations that impact that changeover. -
ChangeoverInstanceId: integer
(int64)
Value that uniquely identifies the changeover instance.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
-
CreationDate: string
(date-time)
Read Only:
true
-
DurationUnit: string
Maximum Length:
30
Time unit of measure for the duration. Valid values include seconds, minutes, hours, days. -
ElapsedDuration: number
Duration that elapsed for the changeover instance.
-
EndDate: string
(date-time)
Date and time when the record is no longer effective..
-
FromResourceSequenceNumber: integer
Number that identifies the resource sequence of the from operation.
-
FromWorkOrderOperationCode: string
Read Only:
true
Maximum Length:300
Abbreviation that identifies the operation for the upstream operation that triggers a changeover. -
FromWorkOrderOperationId: integer
(int64)
Value that uniquely identifies the operation of the from work order.
-
FromWorkOrderOperationName: string
Read Only:
true
Maximum Length:120
Name of the operation for the upstream operation that triggers a changeover. -
LastUpdateDate: string
(date-time)
Read Only:
true
-
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
-
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PlanId: integer
(int64)
Value that uniquely identifies the production schedule.
-
ResourceCode: string
Read Only:
true
Maximum Length:300
Abbreviation that identifies the production resource. -
ResourceId: integer
(int64)
Value that uniquely identifies the production resource. It's a primary key of the resource.
-
RunDuration: number
Duration of running for the changeover instance. This value is less then or equal to the elapsed duration.
-
StartDate: string
(date-time)
Date and time when the changeover instance is effective.
-
ToResourceSequenceNumber: integer
Number that identifies the resource sequence of the to operation.
-
ToWorkOrderOperationCode: string
Read Only:
true
Maximum Length:300
Abbreviation that identifies the operation for the downstream operation that triggers a changeover. -
ToWorkOrderOperationId: integer
(int64)
Value that uniquely identifies the operation of the to work order.
-
ToWorkOrderOperationName: string
Read Only:
true
Maximum Length:120
Name of the operation for the downstream operation that triggers a changeover. -
WorkCenterCode: string
Read Only:
true
Maximum Length:100
Abbreviation that identifies the work center. -
WorkCenterId: integer
(int64)
Value that uniquely identifies the work center. It's a primary key of the work center.
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : productionSchedulingPlans-changeoverInstances-changeoverInstanceDetails-item-response
Type:
Show Source
object
-
AttributeCode: string
Read Only:
true
Maximum Length:300
Abbreviation that identifies the attribute. -
AttributeId: integer
(int64)
Value that uniquely identifies the attribute.
-
AttributeName: string
Read Only:
true
Maximum Length:100
Name of the attribute for a changeover instance. -
ChangeoverInstanceId: integer
(int64)
Value that uniquely identifies the changeover instance.
-
Cost: number
Cost of changeover for the changeover rule.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
-
CreationDate: string
(date-time)
Read Only:
true
-
Duration: number
Duration of the changeover instance.
-
DurationUnit: string
Maximum Length:
30
Time unit of measure for the duration. Valid values include seconds, minutes, hours, days. -
FromAttributeValueCode: string
Read Only:
true
Maximum Length:300
Abbreviation that identifies the from attribute value. -
FromAttributeValueId: integer
(int64)
Value that uniquely identifies the from attribute value.
-
LastUpdateDate: string
(date-time)
Read Only:
true
-
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
-
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PlanId: integer
(int64)
Value that uniquely identifies the production schedule.
-
ToAttributeValueCode: string
Read Only:
true
Maximum Length:300
Abbreviation that identifies the to attribute value. -
ToAttributeValueId: integer
(int64)
Value that uniquely identifies the to attribute value.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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.
Links
- changeoverInstanceDetails
-
Parameters:
- PlanId:
$request.path.PlanId
- changeoverInstancesUniqID:
$request.path.changeoverInstancesUniqID
The Changeover Instance Details resource manages the details of the changeovers including the attributes and durations that impact that changeover. - PlanId: