Get one temporal relation
get
/fscmRestApi/resources/11.13.18.05/productionSchedulingPlans/{PlanId}/child/workOrderTemporalRelations/{workOrderTemporalRelationsUniqID}
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=
-
workOrderTemporalRelationsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- PlanId, FromWorkOrderOperationId, FromResourceSequenceNumber, ToWorkOrderOperationId and ToResourceSequenceNumber ---for the Work Order Temporal Relations resource and used to uniquely identify an instance of Work Order Temporal Relations. The client should not generate the hash key value. Instead, the client should query on the Work Order Temporal Relations collection resource with a filter on the primary key values in order to navigate to a specific instance of Work Order Temporal Relations.
For example: workOrderTemporalRelations?q=PlanId=<value1>;FromWorkOrderOperationId=<value2>;FromResourceSequenceNumber=<value3>;ToWorkOrderOperationId=<value4>;ToResourceSequenceNumber=<value5>
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(required):
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(required):
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-workOrderTemporalRelations-item-response
Type:
Show Source
object
-
FromDurationResourceCode: string
Read Only:
true
Maximum Length:300
Abbreviation that identifies the duration resource for the from operation of a work order operation. -
FromDurationResourceId: number
Read Only:
true
Value that uniquely identifies the from duration resource. -
FromOperationCode: string
Read Only:
true
Maximum Length:300
Abbreviation that identifies the from operation of a work order. -
FromOperationName: string
Read Only:
true
Maximum Length:120
Name of the operation for the from operation of a work order. -
FromOperationSequenceNumber: number
Read Only:
true
Number that identifies the from operation sequence. -
FromResourceSequenceNumber: integer
(int64)
Read Only:
true
Number that identifies the resource sequence of the from operation. -
FromWorkCenterCode: string
Read Only:
true
Maximum Length:100
Abbreviation that identifies the work center from the from operation of a resource. -
FromWorkCenterId: integer
(int64)
Read Only:
true
Value that uniquely identifies the operation of the work center. -
FromWorkOrderOperationId: integer
(int64)
Read Only:
true
Value that identifies the operation of the from work order. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaximumSeparation: number
Maximum separation duration between operations.
-
MaximumSeparationUnit: string
Maximum Length:
20
Time unit of measure for the maximum separation. Valid values include seconds, minutes, hours, days, shifts, weeks, and months. -
MinimumSeparation: number
Minimum separation duration between operations.
-
MinimumSeparationUnit: string
Maximum Length:
20
Time unit of measure for the minimum separation. Valid values include seconds, minutes, hours, days, shifts, weeks, and months. -
PlanId: integer
(int64)
Read Only:
true
Value that uniquely identifies the production schedule. -
TemporalConstraintType: string
Maximum Length:
20
Type of temporal constraint. Valid values include StartsAfterEnd, StartsAtEnd, StartsAfterStart, StartsAtStart, and EndsAtEnd. -
ToDurationResourceCode: string
Read Only:
true
Maximum Length:300
Abbreviation that identifies the resource for the duration resource in the to operation. -
ToDurationResourceId: number
Read Only:
true
Value that uniquely identifies the resultant production resource. -
ToOperationCode: string
Read Only:
true
Maximum Length:300
Abbreviation that identifies the to operation of a work order. -
ToOperationName: string
Read Only:
true
Maximum Length:120
Name of the operation of a work order. -
ToOperationSequenceNumber: number
Read Only:
true
Number that identifies the to operation sequence. -
ToResourceSequenceNumber: integer
(int64)
Read Only:
true
Number that identifies the resource sequence of the to work order operation. -
ToWorkCenterCode: string
Read Only:
true
Maximum Length:100
Abbreviation that identifies the to work center. -
ToWorkCenterId: integer
(int64)
Read Only:
true
Value that uniquely identifies the to work center. -
ToWorkOrderOperationId: integer
(int64)
Read Only:
true
Value the uniquely identifies the to work order operation. -
WorkOrderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work order. It's a primary key of the work order. -
WorkOrderNumber: string
Read Only:
true
Maximum Length:300
Number that uniquely identifies the work order.
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.