Get one equipment instance association
get
/fscmRestApi/resources/11.13.18.05/workstations/{WorkstationId}/child/WorkstationEquipmentInstance/{WsEquipmentInstanceId}
Request
Path Parameters
-
WorkstationId(required): integer(int64)
Value that uniquely identifies the workstation. It's a primary key that the application generates when it creates a workstation.
-
WsEquipmentInstanceId(required): integer(int64)
Value that uniquely identifies the equipment instance associated with workstation. It's a primary key that the application generates when it creates an equipment instance association with a workstation. This attribute is required.
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 : workstations-WorkstationEquipmentInstance-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the row. -
CreationDate: string
(date-time)
Read Only:
true
Date and time of the creation of the row. -
EquipmentInstanceCode: string
Title:
Code
Read Only:true
Maximum Length:80
Abbreviation that identifies the equipment instance that is associated with this workstation. -
EquipmentInstanceId: integer
(int64)
Value that uniquely identifies the equipment instance that is associated with this workstation.
-
EquipmentInstanceName: string
Title:
Name
Read Only:true
Maximum Length:120
Name of the equipment instance that is associated with this workstation. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time of the last update of the row. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who last updated the row. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Session login associated with the user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ResourceDescription: string
Title:
Resource Description
Read Only:true
Maximum Length:240
Description of the production resource. -
ResourceId: integer
(int64)
Read Only:
true
Value that uniquely identifies the production resource. It's a primary key that the application generates when it creates a production resource. -
ResourceName: string
Title:
Resource Name
Read Only:true
Maximum Length:80
Name of the production resource. -
WorkstationId: integer
(int64)
Value that uniquely identifies the workstation. It's a primary key that the application generates when it creates a workstation.
-
WsEquipmentInstanceId: integer
(int64)
Value that uniquely identifies the equipment instance associated with workstation. It's a primary key that the application generates when it creates an equipment instance association with a workstation. This attribute is required.
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
- WorkstationEquipmentInstanceLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: EquipmentInstanceId; Target Attribute: EquipmentInstanceId
- Display Attribute: EquipmentInstanceId
Examples
This example describes how to get one workstation equipment instance association.
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/workstations/WorkstationId/child/WorkstationEquipmentInstance/WsEquipmentInstanceId"
For example:
curl -u username:password "https://servername/fscmRestApi/resources/version/workstations/300100599122054/child/WorkstationEquipmentInstance/300100604774847"
Example Response Body
The following example includes the contents of the response body
in JSON format:
{ "WsEquipmentInstanceId": 300100604774847, "EquipmentInstanceId": 300100599120122, "EquipmentInstanceCode": "WEL_TORCH001", "EquipmentInstanceName": "Welding Torch 001", "ResourceId": 300100081228472, "ResourceName": "Welding Torch", "ResourceDescription": "Welding Torch", "WorkstationId": 300100599122054, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/workstations/300100599122054/child/WorkstationEquipmentInstance/300100604774847", "name": "WorkstationEquipmentInstance", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/workstations/300100599122054/child/WorkstationEquipmentInstance/300100604774847", "name": "WorkstationEquipmentInstance", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/workstations/300100599122054", "name": "workstations", "kind": "item" } ] }