Get all resources
get
/fscmRestApi/resources/11.13.18.05/workCenters/{WorkCenterId}/child/WorkCenterResource
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 -
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 details of the assignment for the work center resource according to the resource ID as the primary key.
Finder Variables:- ResourceId; integer; Primary key that uniquely identifies the work center resource. Manufacturing generates this primary key when it creates the work center resource. This attribute is required.
- 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.
- PrimaryKey: Finds details of the assignment for the work center resource according to the resource 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:- Available24HoursFlag; boolean; 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; 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.
- ResourceCode; string; Abbreviation that identifies the work center resource.
- ResourceDescription; string; Description of the work center resource.
- ResourceId; integer; 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; Name of the work center resource.
- ResourceType; string; Indicates the type of the resource, equipment, or labor.
- WorkCenterId; integer; Value that uniquely identifies the work center that this work center resource references.
-
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:
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-WorkCenterResource
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:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The 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:
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. -
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. -
UtilizationPercentage: number
Title:
Utilization
Default Value:100
Percent of time that is available to perform the task. -
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 : 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-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)
Read Only:
true
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
Examples
This example describes how to get all resources.
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/child/WorkCenterResource"
Example Response Body
The following shows an example of the response body in JSON format.
{ "ResourceId" : 300100073217879, "ResourceName" : "CST_Resource", "ResourceDescription" : "Resource Created to Test Cost Planning Tests", "WorkCenterId" : 300100073218337, "ResourceQuantity" : 100, "Available24HoursFlag" : true, "CheckCtpFlag" : true, "UtilizationPercentage" : 90, "EfficiencyPercentage" : 80, "links" : [ { ... }] }