1. REST API for Oracle Supply Chain Management Cloud
  2. Tasks
  3. Manufacturing
  4. Work Centers

Get all work centers

get

/fscmRestApi/resources/11.13.18.05/workCenters

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 work centers according to the work center ID as the primary key.
      Finder Variables:
      • WorkCenterId; integer; Primary key that uniquely identifies the work center. Manufacturing generates this primary key when it creates the work center. This attribute is required.
    • WorkCentersByResourceId: Finds work centers according to the resource ID as the primary key.
      Finder Variables:
      • ResourceId; integer; Primary key that uniquely identifies the production resource. This attribute is required.
    • WorkCentersBySubinventory: Finds work centers according to the subinventory name as the primary key.
      Finder Variables:
      • SubinventoryName; string; Name of the source subinventory. This attribute is required.
    • WorkCentersChangedAfter: Finds work centers that changed after a specified date.
      Finder Variables:
      • ChangedDate; string; Date when the work center changed.
  • 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:
    • InactiveDate; string; Date when the work center becomes inactive.
    • OrganizationCode; string; Abbreviation that identifies the inventory organization.
    • OrganizationId; integer; Value that uniquely identifies the inventory organization. It is a primary key that the application generates when it creates an inventory organization.
    • OverrideScheduleFlag; boolean; Indicates if the work center has one or more override calendars.
    • ResourceCount; integer; Number of resources assigned to the work center.
    • Status; string; Status of the work center, whether active or inactive.
    • WorkAreaCode; string; Abbreviation that identifies the work area.
    • WorkAreaId; integer; Value that uniquely identifies the work area. It is a primary key that the application generates when it creates a work area.
    • WorkAreaName; string; Name of the work area.
    • WorkCenterCode; string; Abbreviation that identifies the work center.
    • WorkCenterDescription; string; Description of the work center.
    • WorkCenterId; integer; Value that uniquely identifies the work center. It is a primary key that the application generates when it creates a work center.
    • WorkCenterName; string; Name of the work center.
  • 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 : workCenters
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : workCenters-item-response
Type: object
Show Source
Nested Schema : Production Calendars
Type: array
Title: Production Calendars
The Production Calendars of the work center are date effective override calendars for a manufacturing work center.
Show Source
Nested Schema : Flexfields for Work Centers
Type: array
Title: Flexfields for Work Centers
The Flexfields for Work Centers resource manages the descriptive flexfields that the work center references.
Show Source
Nested Schema : Work Center Resources
Type: array
Title: Work Center Resources
The Work Center Resources resource manages work center resources that the work center uses.
Show Source
Nested Schema : Subinventories for Work Centers
Type: array
Title: Subinventories for Work Centers
The Subinventories for Work Centers resource manages the subinventories that each work center uses. You can use only one subinventory as the supply subinventory for each work center.
Show Source
Nested Schema : workCenters-productionCalendars-item-response
Type: object
Show Source
Nested Schema : Resource Shifts
Type: array
Title: Resource Shifts
The Resource Shifts for work center resources are applicable when the override schedule indicator is set to Yes for a work center. The application automatically creates each shift when you assign a production resource to a work center.
Show Source
Nested Schema : Shifts
Type: array
Title: Shifts
The Shifts for production calendars are the shift definitions for date effective override calendars.
Show Source
Nested Schema : workCenters-productionCalendars-resourceShifts-item-response
Type: object
Show Source
Nested Schema : workCenters-productionCalendars-shifts-item-response
Type: object
Show Source
Nested Schema : workCenters-WorkCenterDFF-item-response
Type: object
Show Source
  • Title: Context Segment
    Maximum Length: 80
    Descriptive flexfield context name for work centers.
  • Title: Context Segment
    Descriptive flexfield context display value for work centers.
  • Links
  • Value that uniquely identifies the work center. You can use a flexfield with this work center resource. A flexfield is a flexible data field that your organization can use to modify your implementation without having to write programming code.
Nested Schema : workCenters-WorkCenterResource-item-response
Type: object
Show Source
  • Title: Available 24 Hours
    Maximum Length: 1
    Default Value: false
    Contains one of the following values: true or false. If true, then the work center resource is available 24 hours each day. If false, then the work center resource is not available 24 hours each day. A work center resource that is not available 24 hours each day is available only during the shifts that you assign to this work center resource. A work center resource is available in shifts only if this attribute is set to false. The default value is true.
  • Title: Check Capable to Promise
    Maximum Length: 1
    Default Value: false
    Contains one of the following values: true or false. If true, then Oracle Global Order Promising Cloud considers the capacity of this work center resource during order promising. If false, then Global Order Promising does not consider this capacity. If this attribute is set to false, then the capable-to-promise (CTP) check does not consider the capacity of this work center resource. The default value is false.
  • Title: Efficiency
    Default Value: 100
    Percent of time that the work center resource requires to finish the task.
  • Read Only: true
    Date when the resource becomes inactive.
  • Links
  • Title: Code
    Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the work center resource.
  • Title: Description
    Read Only: true
    Maximum Length: 240
    Description of the work center resource.
  • Value that uniquely identifies the work center resource. It is a primary key that the application generates when it creates a work center resource.
  • Title: Name
    Maximum Length: 80
    Name of the work center resource.
  • Title: Default Units Available
    Number of work center resources assigned to this work center.
  • Read Only: true
    Maximum Length: 30
    Indicates the type of the resource, equipment, or labor.
  • Title: Type
    Read Only: true
    Maximum Length: 30
    Indicates the type of the resource, equipment, or labor.
  • Title: Utilization
    Default Value: 100
    Percent of time that is available to perform the task.
  • Value that uniquely identifies the work center production calendars record. This is an application generated unique ID.
  • Read Only: true
    Value that uniquely identifies the work center that this work center resource references.
  • Shifts for Work Center Resources
    Title: Shifts for Work Center Resources
    The Shifts for Work Center Resources manages the shifts for each work center resource. The application automatically creates each shift when you assign a production resource to a work center.
Nested Schema : Shifts for Work Center Resources
Type: array
Title: Shifts for Work Center Resources
The Shifts for Work Center Resources manages the shifts for each work center resource. The application automatically creates each shift when you assign a production resource to a work center.
Show Source
Nested Schema : workCenters-WorkCenterResource-WorkCenterResourceShift-item-response
Type: object
Show Source
Nested Schema : workCenters-WorkCenterSubinventory-item-response
Type: object
Show Source
Links
viewResourceAvailabilityForCalendar
Gets the list of resources and its shift units for the calendar associated to the work center
Back to Top

Examples

This example describes how to get all work centers.

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/workCenters"

Example Response Body

The following example includes the contents of the response body in JSON format:

{
  "items" : [ {
    "OrganizationId" : 204,
    "OrganizationCode" : "V1",
    "OrganizationName" : "Vision Operations",
    "WorkCenterId" : 300100073217929,
    "WorkCenterCode" : "MFGPACKING1",
    "WorkCenterName" : "MFGPACKING1",
    "WorkCenterDescription" : "Work Center for Packing",
    "InactiveDate" : null,
    "WorkAreaId" : 300100073217895,
    "WorkAreaCode" : "MFGASSYWA1",
    "WorkAreaName" : "MFGASSYWA1",
    "WorkAreaDescription" : "Assembly Work Area1"
  }, {
...
  } ],
...
}
Back to Top