Get one work center
get
/fscmRestApi/resources/11.13.18.05/workCenters/{WorkCenterId}
Request
Path Parameters
-
WorkCenterId(required): integer(int64)
Value that uniquely identifies the work center. It is a primary key that the application generates when it creates a work center.
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 : workCenters-item-response
Type:
Show Source
object
-
InactiveDate: string
(date)
Title:
Inactive On
Date when the work center becomes inactive. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrganizationCode: string
Maximum Length:
18
Abbreviation 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:
true
Maximum Length:240
Name of the inventory organization. -
OverrideScheduleFlag: boolean
Title:
Override schedule
Maximum Length:1
Indicates if the work center has one or more override calendars. -
productionCalendars: array
Production Calendars
Title:
Production Calendars
The Production Calendars of the work center are date effective override calendars for a manufacturing work center. -
ResourceCount: integer
Read Only:
true
Number of resources assigned to the work center. -
Status: string
Read Only:
true
Maximum Length:255
Status of the work center, whether active or inactive. -
WorkAreaCode: string
Title:
Code
Read Only:true
Maximum Length:30
Abbreviation that identifies the work area. -
WorkAreaDescription: string
Title:
Description
Read Only:true
Maximum Length:240
Description of the work area. -
WorkAreaId: integer
(int64)
Title:
Work Area
Value that uniquely identifies the work area. It is a primary key that the application generates when it creates a work area. -
WorkAreaName: string
Title:
Name
Maximum Length:80
Name of the work area. -
WorkCenterCode: string
Title:
Code
Maximum Length:30
Abbreviation that identifies the work center. -
WorkCenterDescription: string
Title:
Description
Maximum Length:240
Description of the work center. -
WorkCenterDFF: array
Flexfields for Work Centers
Title:
Flexfields for Work Centers
The Flexfields for Work Centers resource manages the descriptive flexfields that the work center references. -
WorkCenterId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work center. It is a primary key that the application generates when it creates a work center. -
WorkCenterName: string
Title:
Name
Maximum Length:120
Name of the work center. -
WorkCenterResource: array
Work Center Resources
Title:
Work Center Resources
The Work Center Resources resource manages work center resources that the work center uses. -
WorkCenterSubinventory: array
Subinventories for Work Centers
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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 : 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 : 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:
true
Maximum Length:64
User who created the production calendar. -
CreationDate: string
(date-time)
Read Only:
true
Date when the user created the production calendar. -
Description: string
Read Only:
true
Maximum Length:2000
Description of the work center calendar. -
EffectiveFromDate: string
(date)
Read Only:
true
Effective From date of the work center calendar. -
EffectiveToDate: string
(date)
Read Only:
true
Effective To date of the work center calendar. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the production calendar. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Login of the user who most recently updated the production calendar. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Who column: indicates the session login associated with the user who last updated the row. -
links: array
Links
Title:
Links
The 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:
240
Name of the work center calendar. -
OrganizationCode: string
Read Only:
true
Maximum Length:18
Organization code. -
OrganizationId: integer
(int64)
Read Only:
true
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
Organization 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 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. -
shifts: array
Shifts
Title:
Shifts
The Shifts for production calendars are the shift definitions for date effective override calendars. -
WorkCenterCode: string
Title:
Code
Read Only:true
Maximum Length:30
Code 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:
Name
Read Only:true
Maximum Length:120
Field value that represents the name of the work center.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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:
Show Source
object
-
AssignedUnits: number
Indicates the number of resource instances assigned to the shift.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
Indicates the user who created the row. -
CreationDate: string
(date-time)
Read Only:
true
Indicates the date and time of the creation of the row. -
LastUpdateDate: string
(date-time)
Read Only:
true
Indicates the date and time of the last update of the row. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Indicates the user who last updated the row. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Indicates the session login associated with the user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ResourceCode: string
Title:
Code
Read Only:true
Maximum Length:30
Abbreviation that identifies the work center resource. -
ResourceId: integer
(int64)
Indicates the resource to which the shift is assigned.
-
ResourceName: string
Title:
Name
Maximum Length:80
Name 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:
240
Name of the shift.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : workCenters-productionCalendars-shifts-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the shift. -
CreationDate: string
(date-time)
Read Only:
true
Date when the user created the shift. -
Description: string
Read Only:
true
Maximum Length:2000
Description of the shift. -
Duration: string
Read Only:
true
Duration of the shift. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the shift. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Login of the user who most recently updated the shift. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Who column: indicates the session login associated with the user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Read Only:
true
Maximum Length:240
Name of the shift. -
ShiftId: integer
Read Only:
true
Value that uniquely identifies the shift that the calendar references. -
StartTime: string
Read Only:
true
Start time of the shift.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : workCenters-WorkCenterDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:80
Descriptive flexfield context name for work centers. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Descriptive flexfield context display value for work centers. -
links: array
Links
Title:
Links
The 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:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : workCenters-WorkCenterResource-item-response
Type:
Show Source
object
-
Available24HoursFlag: boolean
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. -
CheckCtpFlag: boolean
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. -
EfficiencyPercentage: number
Title:
Efficiency
Default Value:100
Percent of time that the work center resource requires to finish the task. -
InactiveDate: string
(date)
Read Only:
true
Date when the resource becomes inactive. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ResourceCode: string
Title:
Code
Read Only:true
Maximum Length:30
Abbreviation that identifies the work center resource. -
ResourceDescription: string
Title:
Description
Read Only:true
Maximum Length:240
Description 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:
Name
Maximum Length:80
Name of the work center resource. -
ResourceQuantity: number
Title:
Default Units Available
Number of work center resources assigned to this work center. -
ResourceType: string
Read Only:
true
Maximum Length:30
Indicates the type of the resource, equipment, or labor. -
ResourceTypeCode: string
Title:
Type
Read Only:true
Maximum Length:30
Indicates the type of the resource, equipment, or labor. -
UtilizationPercentage: number
Title:
Utilization
Default Value:100
Percent 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:
true
Value that uniquely identifies the work center that this work center resource references. -
WorkCenterResourceShift: array
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
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:
Show Source
object
-
AssignedUnits: number
Number of resources assigned to the shift.
-
Duration: string
Read Only:
true
Maximum Length:255
Duration of the shift. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PlantCalendarId: integer
Read Only:
true
Value 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:
true
Name of the shift. -
StartTime: string
Read Only:
true
Start time of the shift. -
WorkCenterId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work center that this work center resource references.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : workCenters-WorkCenterSubinventory-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Locator: string
Maximum Length:
255
Subinventory locator that this locator references. Do not use this attribute with a POST or PATCH operation. -
LocatorId: integer
(int64)
Title:
Supply Locator
Value that uniquely identifies the subinventory locator that this locator references. -
SubinventoryName: string
Title:
Supply Subinventory
Maximum Length:10
Name of the subinventory. -
WorkCenterId: integer
(int64)
Read Only:
true
Value 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:
true
Maximum Length:30
Default Value:SUPPLY
Type of subinventory. Valid values include Storage or Receiving.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- WorkCenterDFF
-
Parameters:
- WorkCenterId:
$request.path.WorkCenterId
The Flexfields for Work Centers resource manages the descriptive flexfields that the work center references. - WorkCenterId:
- WorkCenterResource
-
Parameters:
- WorkCenterId:
$request.path.WorkCenterId
The Work Center Resources resource manages work center resources that the work center uses. - WorkCenterId:
- WorkCenterSubinventory
-
Operation: /fscmRestApi/resources/11.13.18.05/workCenters/{WorkCenterId}/child/WorkCenterSubinventoryParameters:
- WorkCenterId:
$request.path.WorkCenterId
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. - WorkCenterId:
- productionCalendars
-
Parameters:
- WorkCenterId:
$request.path.WorkCenterId
The Production Calendars of the work center are date effective override calendars for a manufacturing work center. - WorkCenterId:
Examples
This example describes how to get one work center.
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/WorkCenterId"
For example, the following command gets work center 300100073217929:
curl -u username:password "https://servername/fscmRestApi/resources/version/workCenters/300100073217929"
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "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" }