Get one resource instance
get
/fscmRestApi/resources/11.13.18.05/processWorkOrders/{processWorkOrdersUniqID}/child/Operation/{OperationUniqID}/child/Resource/{ResourceUniqID}/child/ResourceInstance/{WorkOrderOperationResourceInstanceId}
Request
Path Parameters
-
OperationUniqID(required): string
This is the hash key of the attributes which make up the composite key 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 in order to navigate to a specific instance of Operations to get the hash key.
-
ResourceUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Resources resource and used to uniquely identify an instance of Resources. The client should not generate the hash key value. Instead, the client should query on the Resources collection resource in order to navigate to a specific instance of Resources to get the hash key.
-
WorkOrderOperationResourceInstanceId(required): integer(int64)
Value that uniquely identifies the resource instance of a work order operation resource. It's a primary key that the application generates when it creates the resource instance for the work order operation resource.
-
processWorkOrdersUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Process Work Orders resource and used to uniquely identify an instance of Process Work Orders. The client should not generate the hash key value. Instead, the client should query on the Process Work Orders collection resource in order to navigate to a specific instance of Process Work Orders to get the hash key.
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 : processWorkOrders-Operation-Resource-ResourceInstance-item-response
Type:
Show Source
object
-
ChargedQuantity: number
Title:
Actual Usage
Read Only:true
Actual usage of the resource instance. -
EquipmentInstanceCode: string
Title:
Identifier
Maximum Length:80
Abbreviation that identifies the equipment resource instance. -
EquipmentInstanceId: integer
(int64)
Value that uniquely identifies the equipment resource instance. It's a primary key that the application generates when it creates a equipment instance.
-
EquipmentInstanceName: string
Title:
Name
Read Only:true
Maximum Length:120
Name of the equipment resource instance. -
LaborInstanceCode: string
Title:
Identifier
Maximum Length:30
Abbreviation that identifies the labor resource instance. -
LaborInstanceId: integer
(int64)
Value that uniquely identifies the labor resource instance. It's a primary key that the application generates when it creates a labor instance.
-
LaborInstanceName: string
Title:
Name
Read Only:true
Maximum Length:360
Name of the labor resource instance. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrganizationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the inventory organization that's enabled for manufacturing. It's a primary key of the inventory organization. -
ProgramFileName: string
Maximum Length:
300
Name of the program file associated with the automation equipment resource and used by the work order resource instance. -
ResourceInstanceDFF: array
Flexfields for Resource Instances
Title:
Flexfields for Resource Instances
The Flexfields for Resource Instances resource manages descriptive flexfields that contain details about the resource instance. -
ResourceType: string
Read Only:
true
Maximum Length:255
Type of the resource. Values include Labor or Equipment. -
WorkOrderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work order. It's a primary key that the application generates when it creates the work order. -
WorkOrderOperationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work order operation. It's a primary key that the application generates when it creates the work order operation. -
WorkOrderOperationResourceId: integer
(int64)
Value that uniquely identifies the resource of a work order operation. It's a primary key that the application generates when it creates the resource for the work order operation.
-
WorkOrderOperationResourceInstanceId: integer
(int64)
Value that uniquely identifies the resource instance of a work order operation resource. It's a primary key that the application generates when it creates the resource instance for the work order operation resource.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Flexfields for Resource Instances
Type:
array
Title:
Flexfields for Resource Instances
The Flexfields for Resource Instances resource manages descriptive flexfields that contain details about 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.
Nested Schema : processWorkOrders-Operation-Resource-ResourceInstance-ResourceInstanceDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:80
Descriptive flexfield context name for work order operation resource instance. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Descriptive flexfield context display value for work order operation resource instance. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
WoOpResourceInstanceId: integer
(int64)
Value that uniquely identifies an output of a work order operation resource instance. It's a primary key that the application generates when it creates the work order operation resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- ResourceInstanceDFF
-
Parameters:
- OperationUniqID:
$request.path.OperationUniqID
- ResourceUniqID:
$request.path.ResourceUniqID
- WorkOrderOperationResourceInstanceId:
$request.path.WorkOrderOperationResourceInstanceId
- processWorkOrdersUniqID:
$request.path.processWorkOrdersUniqID
The Flexfields for Resource Instances resource manages descriptive flexfields that contain details about the resource instance. - OperationUniqID: