Get one instance
get
/fscmRestApi/resources/11.13.18.05/productionResources/{ResourceId}/child/EquipmentInstance/{EquipmentInstanceId}
Request
Path Parameters
-
EquipmentInstanceId(required): integer(int64)
Value that uniquely identifies the equipment resource instance. It is a primary key that the application generates when it creates a equipment instance.
-
ResourceId(required): integer(int64)
Value that uniquely identifies the production resource. It's a primary key that the application generates when it creates a production resource.
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 : productionResources-EquipmentInstance-item-response
Type:
Show Source
object
-
AssetDescription: string
Read Only:
true
Maximum Length:240
Description of the asset that identifies the equipment instance. -
AssetId: integer
(int64)
Title:
Asset Number
Value that uniquely identifies the item associated with the asset in the maintenance organization. -
AssetItemDescription: string
Title:
Item Description
Read Only:true
Maximum Length:240
Description of the asset in the maintenance organization. -
AssetItemId: integer
(int64)
Read Only:
true
Value that uniquely identifies the item associated with the asset in the maintenance organization. -
AssetItemNumber: string
Read Only:
true
Maximum Length:300
Item number of the asset that identifies the equipment instance. -
AssetNumber: string
Maximum Length:
80
Unique asset number that identifies the equipment instance. -
EquipmentIdentifier: string
Title:
Identifier
Maximum Length:80
Abbreviation that identifies the equipment resource instance. -
EquipmentInstanceDFF: array
Flexfields for Equipment Instances
Title:
Flexfields for Equipment Instances
The Flexfields for Equipment Instances resource manages descriptive flexfields that the equipment instances uses. -
EquipmentInstanceId: integer
(int64)
Value that uniquely identifies the equipment resource instance. It is a primary key that the application generates when it creates a equipment instance.
-
EquipmentInstanceName: string
Title:
Name
Maximum Length:120
Name of the equipment resource instance. -
InactiveDate: string
(date)
Title:
Inactive On
Date when the equipment instance becomes inactive. -
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. It is a primary key that the application generates when it creates an inventory organization. -
PrimaryWorkCenterCode: string
Title:
Code
Maximum Length:30
Abbreviation that identifies the primary work center. -
PrimaryWorkCenterId: integer
(int64)
Title:
Primary Work Center
Value that uniquely identifies the work center. It is a primary key that the application generates when it creates a work center. This is the default work center that the application assigns to this equipment instance. -
PrimaryWorkCenterName: string
Title:
Name
Read Only:true
Maximum Length:120
Abbreviation that identifies the name of the primary work center. -
ResourceCode: string
Title:
Code
Read Only:true
Maximum Length:30
Abbreviation that identifies the production resource. -
ResourceId: integer
(int64)
Value that uniquely identifies the production resource. It is a primary key that the application generates when it creates a production resource.
Nested Schema : Flexfields for Equipment Instances
Type:
array
Title:
Flexfields for Equipment Instances
The Flexfields for Equipment Instances resource manages descriptive flexfields that the equipment instances uses.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : productionResources-EquipmentInstance-EquipmentInstanceDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:80
Descriptive flexfield context name for equipment instances. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Descriptive flexfield context display value for equipment instances. -
EquipmentInstanceId: integer
(int64)
Value that uniquely identifies the equipment resource instance. It is a primary key that the application generates when it creates a equipment instance.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
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
- EquipmentInstanceDFF
-
Parameters:
- EquipmentInstanceId:
$request.path.EquipmentInstanceId
- ResourceId:
$request.path.ResourceId
The Flexfields for Equipment Instances resource manages descriptive flexfields that the equipment instances uses. - EquipmentInstanceId:
Examples
This example describes how to get one instance.
Example cURL Command
Use the following cURL command to submit a request on the REST resource:
curl -u username:password "https://servername/fscmRestApi/resources/version/productionResources/ResourceId/child/EquipmentInstance/EquipmentInstanceId"
For example, the following command gets one instance where the equipment instance identifier is 300100150115731:
curl -u username:password "https://servername/fscmRestApi/resources/version/productionResources/ResourceId/child/EquipmentInstance/300100150115731"
Example Response Body
The following shows an example of the response body in JSON format.
{ "EquipmentInstanceId" : 300100150115731, "EquipmentIdentifier" : "ASSY-DRILL-001", "EquipmentInstanceName" : "Automatic Assembly Drilling Machine", "AssetId" : 300100150115717, "AssetNumber" : "DRILL-001", "AssetDescription" : "Drilling Machine", "AssetItemId" : 300100013645842, "AssetItemNumber" : "alm-srl-001", "AssetItemDescription" : "Serialized Asset Item", "OrganizationId" : 207, "ResourceId" : 300100150115730, "ResourceCode" : "ASSY-DRILL-001", "PrimaryWorkCenterId" : null, "PrimaryWorkCenterCode" : null, "InactiveDate" : null, "links" : [ { ... }] }