Get all work centers
get
/fscmRestApi/resources/11.13.18.05/workCenters
Request
Query Parameters
-
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 -
finder: string
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.
- PrimaryKey: Finds work centers according to the work center ID as the primary key.
-
limit: integer
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.
-
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 -
offset: integer
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.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
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
-
q: string
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:- HcmDepartmentId; integer; Indicates the HCM department associated with the work center
- HcmDepartmentMeaning; string; Indicates the HCM department name associated with the work center.
- 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.
-
totalResults: boolean
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
-
Metadata-Context: string
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: string
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 : workCenters
Type:
Show Source
object-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
ItemsThe items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
LinksThe link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : workCenters-item-response
Type:
Show Source
object-
HcmDepartmentId: integer
(int64)
Indicates the HCM department associated with the work center
-
HcmDepartmentMeaning: string
Read Only:
trueMaximum Length:255Indicates the HCM department name associated with the work center. -
InactiveDate: string
(date)
Title:
Inactive OnDate when the work center becomes inactive. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
OrganizationCode: string
Maximum Length:
18Abbreviation that identifies the inventory organization. -
OrganizationId: integer
(int64)
Value that uniquely identifies the inventory organization. It is a primary key that the application generates when it creates an inventory organization.
-
OrganizationName: string
Read Only:
trueMaximum Length:240Name of the inventory organization. -
OverrideScheduleFlag: boolean
Title:
Override scheduleMaximum Length:1Indicates if the work center has one or more override calendars. -
productionCalendars: array
Production Calendars
Title:
Production CalendarsThe Production Calendars of the work center are date effective override calendars for a manufacturing work center. -
ResourceCount: integer
Read Only:
trueNumber of resources assigned to the work center. -
Status: string
Read Only:
trueMaximum Length:255Status of the work center, whether active or inactive. -
WorkAreaCode: string
Title:
CodeRead Only:trueMaximum Length:30Abbreviation that identifies the work area. -
WorkAreaDescription: string
Title:
DescriptionRead Only:trueMaximum Length:240Description of the work area. -
WorkAreaId: integer
(int64)
Title:
Work AreaValue that uniquely identifies the work area. It is a primary key that the application generates when it creates a work area. -
WorkAreaName: string
Title:
NameMaximum Length:80Name of the work area. -
WorkCenterCode: string
Title:
CodeMaximum Length:30Abbreviation that identifies the work center. -
WorkCenterDescription: string
Title:
DescriptionMaximum Length:240Description of the work center. -
WorkCenterDFF: array
Flexfields for Work Centers
Title:
Flexfields for Work CentersThe Flexfields for Work Centers resource manages the descriptive flexfields that the work center references. -
WorkCenterId: integer
(int64)
Read Only:
trueValue that uniquely identifies the work center. It is a primary key that the application generates when it creates a work center. -
WorkCenterName: string
Title:
NameMaximum Length:120Name of the work center. -
WorkCenterResource: array
Work Center Resources
Title:
Work Center ResourcesThe Work Center Resources resource manages work center resources that the work center uses. -
WorkCenterSubinventory: array
Subinventories for Work Centers
Title:
Subinventories for Work CentersThe 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.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Production Calendars
Type:
arrayTitle:
Production CalendarsThe 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:
arrayTitle:
Flexfields for Work CentersThe Flexfields for Work Centers resource manages the descriptive flexfields that the work center references.
Show Source
Nested Schema : Work Center Resources
Type:
arrayTitle:
Work Center ResourcesThe Work Center Resources resource manages work center resources that the work center uses.
Show Source
Nested Schema : Subinventories for Work Centers
Type:
arrayTitle:
Subinventories for Work CentersThe 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 : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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 : workCenters-productionCalendars-item-response
Type:
Show Source
object-
AssociationEndDate: string
(date)
Indicates the end date for the work center calendar's association.
-
AssociationStartDate: string
(date)
Indicates the work center calendar association's start date.
-
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the production calendar. -
CreationDate: string
(date-time)
Read Only:
trueDate when the user created the production calendar. -
Description: string
Read Only:
trueMaximum Length:2000Description of the work center calendar. -
EffectiveFromDate: string
(date)
Read Only:
trueEffective From date of the work center calendar. -
EffectiveToDate: string
(date)
Read Only:
trueEffective To date of the work center calendar. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate and time when the user most recently updated the production calendar. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64Login of the user who most recently updated the production calendar. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32Who column: indicates the session login associated with the user who last updated the row. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MfgCalendarId: integer
(int64)
Calendar schedule for manufacturing usage. Manufacturing calendars must be of the type Time. This is a foreign key to the ZMM_SR_SCHEDULES_B table that the calendar references.
-
Name: string
Maximum Length:
240Name of the work center calendar. -
OrganizationCode: string
Read Only:
trueMaximum Length:18Organization code. -
OrganizationId: integer
(int64)
Read Only:
trueValue 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:
trueMaximum Length:240Organization name. -
ProductionCalendarId: integer
(int64)
Unique identifier of the work center production calendar's record. Its value is an application-generated unique ID.
-
resourceShifts: array
Resource Shifts
Title:
Resource ShiftsThe 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. -
shifts: array
Shifts
Title:
ShiftsThe Shifts for production calendars are the shift definitions for date effective override calendars. -
WorkCenterCode: string
Title:
CodeRead Only:trueMaximum Length:30Code that represents the user key of the work center. -
WorkCenterId: integer
(int64)
Value that uniquely identifies the work center that the calendar references.
-
WorkCenterName: string
Title:
NameRead Only:trueMaximum Length:120Field value that represents the name of the work center.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Resource Shifts
Type:
arrayTitle:
Resource ShiftsThe 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:
arrayTitle:
ShiftsThe Shifts for production calendars are the shift definitions for date effective override calendars.
Show Source
Nested Schema : workCenters-productionCalendars-resourceShifts-item-response
Type:
Show Source
object-
AssignedUnits: number
Indicates the number of resource instances assigned to the shift.
-
CreatedBy: string
Read Only:
trueMaximum Length:64Indicates the user who created the row. -
CreationDate: string
(date-time)
Read Only:
trueIndicates the date and time of the creation of the row. -
LastUpdateDate: string
(date-time)
Read Only:
trueIndicates the date and time of the last update of the row. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64Indicates the user who last updated the row. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32Indicates the session login associated with the user who last updated the row. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ResourceCode: string
Title:
CodeRead Only:trueMaximum Length:30Abbreviation that identifies the work center resource. -
ResourceId: integer
(int64)
Indicates the resource to which the shift is assigned.
-
ResourceName: string
Title:
NameMaximum Length:80Name of the work center resource. -
ShiftId: integer
(int64)
Represents the shift identifier that's the foreign key to the ZMM_SR_SHIFTS_B table that the shift references.
-
ShiftName: string
Maximum Length:
240Name of the shift.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : workCenters-productionCalendars-shifts-item-response
Type:
Show Source
object-
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the shift. -
CreationDate: string
(date-time)
Read Only:
trueDate when the user created the shift. -
Description: string
Read Only:
trueMaximum Length:2000Description of the shift. -
Duration: string
Read Only:
trueDuration of the shift. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate and time when the user most recently updated the shift. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64Login of the user who most recently updated the shift. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32Who column: indicates the session login associated with the user who last updated the row. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Name: string
Read Only:
trueMaximum Length:240Name of the shift. -
ShiftId: integer
Read Only:
trueValue that uniquely identifies the shift that the calendar references. -
StartTime: string
Read Only:
trueStart time of the shift.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : workCenters-WorkCenterDFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:80Descriptive flexfield context name for work centers. -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentDescriptive flexfield context display value for work centers. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
WorkCenterId: integer
(int64)
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 : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : workCenters-WorkCenterResource-item-response
Type:
Show Source
object-
Available24HoursFlag: boolean
Title:
Available 24 HoursMaximum Length:1Default Value:falseContains 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. -
CheckCtpFlag: boolean
Title:
Check Capable to PromiseMaximum Length:1Default Value:falseContains 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. -
EfficiencyPercentage: number
Title:
EfficiencyDefault Value:100Percent of time that the work center resource requires to finish the task. -
HCMSchedulingGroupCode: string
Read Only:
trueMaximum Length:30Indicates the code of the scheduling group assigned to the work center resource. -
InactiveDate: string
(date)
Read Only:
trueDate when the resource becomes inactive. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ResourceCode: string
Title:
CodeRead Only:trueMaximum Length:30Abbreviation that identifies the work center resource. -
ResourceDescription: string
Title:
DescriptionRead Only:trueMaximum Length:240Description of the work center resource. -
ResourceId: integer
(int64)
Value that uniquely identifies the work center resource. It is a primary key that the application generates when it creates a work center resource.
-
ResourceName: string
Title:
NameMaximum Length:80Name of the work center resource. -
ResourceQuantity: number
Title:
Default Units AvailableNumber of work center resources assigned to this work center. -
ResourceType: string
Read Only:
trueMaximum Length:30Indicates the type of the resource, equipment, or labor. -
ResourceTypeCode: string
Title:
TypeRead Only:trueMaximum Length:30Indicates the type of the resource, equipment, or labor. -
UtilizationPercentage: number
Title:
UtilizationDefault Value:100Percent of time that is available to perform the task. -
WcProdCalendarId: integer
Value that uniquely identifies the work center production calendars record. This is an application generated unique ID.
-
WorkCenterId: integer
(int64)
Read Only:
trueValue that uniquely identifies the work center that this work center resource references. -
WorkCenterResourceShift: array
Shifts for Work Center Resources
Title:
Shifts for Work Center ResourcesThe 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 : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Shifts for Work Center Resources
Type:
arrayTitle:
Shifts for Work Center ResourcesThe 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:
Show Source
object-
AssignedUnits: number
Number of resources assigned to the shift.
-
Duration: string
Read Only:
trueMaximum Length:255Duration of the shift. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PlantCalendarId: integer
Read Only:
trueValue that uniquely identifies the plant calendar that the plant calendar references. -
ShiftId: integer
(int64)
Value that uniquely identifies the shift that the shift references.
-
ShiftName: string
Read Only:
trueName of the shift. -
StartTime: string
Read Only:
trueStart time of the shift. -
WorkCenterId: integer
(int64)
Read Only:
trueValue that uniquely identifies the work center that this work center resource references.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : workCenters-WorkCenterSubinventory-item-response
Type:
Show Source
object-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Locator: string
Maximum Length:
255Subinventory locator that this locator references. Do not use this attribute with a POST or PATCH operation. -
LocatorId: integer
(int64)
Title:
Supply LocatorValue that uniquely identifies the subinventory locator that this locator references. -
SubinventoryName: string
Title:
Supply SubinventoryMaximum Length:10Name of the subinventory. -
WorkCenterId: integer
(int64)
Read Only:
trueValue that uniquely identifies the work center that this work center resource references. -
WorkCenterSubinventoryId: integer
(int64)
Value that uniquely identifies the subinventory associated with the work center that this subinventory references.
-
WorkCenterSubInvType: string
Read Only:
trueMaximum Length:30Default Value:SUPPLYType of subinventory. Valid values include Storage or Receiving.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- viewResourceAvailabilityForCalendar
-
Operation: /fscmRestApi/resources/11.13.18.05/workCenters/action/viewResourceAvailabilityForCalendarGets the list of resources and its shift units for the calendar associated to the work center
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"
}, {
...
} ],
...
}