Get one workstation
get
/fscmRestApi/resources/11.13.18.05/workstations/{WorkstationId}
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.
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-item-response
Type:
Show Source
object
-
Attachments: array
Attachments
Title:
Attachments
The attachments that are associated with workstations. -
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. -
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. -
OrganizationCode: string
Abbreviation that identifies the inventory organization.
-
OrganizationId: integer
(int64)
Value that uniquely identifies the inventory organization. It's a primary key that the application generates when it creates an inventory organization.
-
OrganizationName: string
Read Only:
true
Maximum Length:240
Name of the inventory organization. -
WorkCenterCode: string
Title:
Work Center Code
Read Only:true
Maximum Length:30
Abbreviation that identifies the parent work center. -
WorkCenterDescription: string
Title:
Work Center Description
Read Only:true
Maximum Length:240
Description of the parent work center. -
WorkCenterId: integer
(int64)
Title:
Work Center
Value that uniquely identifies the parent work center. It's a primary key that the application generates when it creates a work center. -
WorkCenterName: string
Title:
Work Center
Read Only:true
Maximum Length:120
Name of the parent work center. -
WorkstationCode: string
Title:
Code
Maximum Length:30
Abbreviation that identifies the workstation. -
WorkstationDescription: string
Title:
Description
Maximum Length:240
Description of the workstation. -
WorkstationEquipmentInstance: array
Workstation Equipment Instances
Title:
Workstation Equipment Instances
Equipment resource instances associated with the workstation. -
WorkstationId: integer
(int64)
Value that uniquely identifies the workstation. It's a primary key that the application generates when it creates a workstation.
-
WorkstationName: string
Title:
Name
Maximum Length:120
Name of the workstation.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments that are associated with workstations.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Workstation Equipment Instances
Type:
array
Title:
Workstation Equipment Instances
Equipment resource instances associated with the workstation.
Show Source
Nested Schema : workstations-Attachments-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
Unique identifier of the attached document. -
AttachmentsPreview: array
Attachment Previews
Title:
Attachment Previews
A preview of workstation attachments. -
CategoryName: string
Title:
Category
Maximum Length:30
Category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
User who created the record. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
Name of the user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the record was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Value that indicates the data type. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
Document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
Error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File Contents
Contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
File name of the attachment. -
FileUrl: string
Title:
File Url
URI of the file. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
User who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
Name of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
Name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
Size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
Name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded Text
Text content for a new text attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
URI of a topology manager type attachment. -
Url: string
Title:
Url
Maximum Length:4000
URL of a web page type attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
Session login associated with the user who created the attachment.
Nested Schema : Attachment Previews
Type:
array
Title:
Attachment Previews
A preview of workstation attachments.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : workstations-Attachments-AttachmentsPreview-item-response
Type:
Show Source
object
-
ImageHeight: integer
Title:
Image Height
Read Only:true
Height of the previewed image. -
ImageSource: string
Title:
Image Source
Read Only:true
Preview of the image in base64 encoded PNG format. -
ImageWidth: integer
Title:
Image Width
Read Only:true
Width of the previewed image. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PageNum: integer
Title:
Page Number
Read Only:true
Number of the page in the preview.
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.
Nested 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
Links
- Attachments
-
Parameters:
- WorkstationId:
$request.path.WorkstationId
The attachments that are associated with workstations. - WorkstationId:
- WorkstationEquipmentInstance
-
Operation: /fscmRestApi/resources/11.13.18.05/workstations/{WorkstationId}/child/WorkstationEquipmentInstanceParameters:
- WorkstationId:
$request.path.WorkstationId
Equipment resource instances associated with the workstation. - WorkstationId:
Examples
This example describes how to get .
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"
For example:
curl -u username:password "https://servername/fscmRestApi/resources/version/workstations/300100604662783"
Example Response Body
The following example includes the contents of the response body
in JSON format:
{ "OrganizationId" : 204, "OrganizationCode" : "V1", "OrganizationName" : "Vision Operations", "WorkstationId" : 300100604662783, "WorkstationCode" : "WS-PACK-002", "WorkstationName" : "WS-Packing-002", "WorkstationDescription" : "Workstation for packing 002", "WorkCenterId" : 300100073217929, "WorkCenterCode" : "MFGPACKING1", "WorkCenterName" : "MFGPACKING1", "WorkCenterDescription" : "Work Center for Packing" }