1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Manufacturing
  4. Workstations

Get all workstations

get

/fscmRestApi/resources/11.13.18.05/workstations

Request

Query Parameters
  • 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).
  • 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
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • PrimaryKey: Finds workstations according to the workstation identifier as the primary key.
      Finder Variables:
      • WorkstationId; integer; Value that uniquely identifies the workstation. It's a primary key that the application generates when it creates a workstation. This attribute is required.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • 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
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • OrganizationCode; string; Abbreviation that identifies the inventory organization.
    • OrganizationId; integer; Value that uniquely identifies the inventory organization. It's a primary key that the application generates when it creates an inventory organization.
    • OrganizationName; string; Name of the inventory organization.
    • WorkCenterCode; string; Abbreviation that identifies the parent work center.
    • WorkCenterDescription; string; Description of the parent work center.
    • WorkCenterId; integer; 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; Name of the parent work center.
    • WorkstationCode; string; Abbreviation that identifies the workstation.
    • WorkstationDescription; string; Description of the workstation.
    • WorkstationId; integer; Value that uniquely identifies the workstation. It's a primary key that the application generates when it creates a workstation.
    • WorkstationName; string; Name of the workstation.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • 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".
  • 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 Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : workstations
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : workstations-item-response
Type: object
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-WorkstationEquipmentInstance-item-response
Type: object
Show Source
  • Title: Code
    Read Only: true
    Maximum Length: 80
    Abbreviation that identifies the equipment instance that is associated with this workstation.
  • Value that uniquely identifies the equipment instance that is associated with this workstation.
  • Title: Name
    Read Only: true
    Maximum Length: 120
    Name of the equipment instance that is associated with this workstation.
  • Links
  • Title: Description
    Read Only: true
    Maximum Length: 240
    Description of the production resource.
  • 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.
  • Title: Name
    Read Only: true
    Maximum Length: 80
    Name of the production resource.
  • Value that uniquely identifies the workstation. It's a primary key that the application generates when it creates a workstation.
  • 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.
Back to Top

Examples

This example describes how to get all workstations.

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"

Example Response Body

The following example includes the contents of the response body in JSON format:
{
  "items" : [ {
    "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"
   }, {
  ...
 } ],
...
}
Back to Top