Get all work order group
get
/fscmRestApi/resources/11.13.18.05/workOrderGroups
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 the work order group with the specified primary key.
Finder Variables:- WoGroupId; integer; Unique identifier of the work order in the work order group.
- PrimaryKey: Finds the work order group with the specified 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:- CreatedBy; string; Indicates the user who created the work order group.
- CreationDate; string; Indicates the date and time when the work order group was created.
- GroupCode; string; Represents the user key for the work order group entity.
- GroupDescription; string; Description of the work order group.
- GroupName; string; Name of the work order group.
- GroupSource; string; Indicates the source of the group definition, allowing for separate groups to be defined for different products, such as Manufacturing or Maintenance. Valid values can be found in the lookup with the lookup type = ORA_WIE_SOURCE.
- InactiveDate; string; Date when the work order group becomes inactive.
- LastUpdateDate; string; Indicates the date and time of the most recent update to the work order group.
- LastUpdateLogin; string; Indicates the session login of the user who last updated the work order group.
- LastUpdatedBy; string; Indicates the user who made the most recent update to the work order group.
- ObjectVersionNumber; integer; This number is used to implement optimistic locking, and it increments each time the row is updated. It's compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
- OrganizationCode; string; Abbreviation that identifies the inventory organization that's enabled for manufacturing.
- OrganizationId; integer; Organization identifier that represents the plant to which this work order group belongs.
- OrganizationIdOrg; integer; Organization identifier that represents the plant to which this work order group is assigned.
- OrganizationName; string; Name of the inventory organization that's enabled for manufacturing.
- Status; string; Represents the status of the work order group.
- WoGroupId; integer; Unique identifier for a work order group record, generated automatically by the application.
-
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 : workOrderGroups
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 : workOrderGroups-item-response
Type:
Show Source
object-
CreatedBy: string
Read Only:
trueMaximum Length:64Indicates the user who created the work order group. -
CreationDate: string
(date-time)
Read Only:
trueIndicates the date and time when the work order group was created. -
GroupCode: string
Title:
Group CodeMaximum Length:30Represents the user key for the work order group entity. -
GroupDescription: string
Title:
Group DescriptionMaximum Length:240Description of the work order group. -
GroupName: string
Maximum Length:
120Name of the work order group. -
GroupSource: string
Title:
Group SourceMaximum Length:30Default Value:ORA_MANUFACTURINGIndicates the source of the group definition, allowing for separate groups to be defined for different products, such as Manufacturing or Maintenance. Valid values can be found in the lookup with the lookup type = ORA_WIE_SOURCE. -
InactiveDate: string
(date)
Date when the work order group becomes inactive.
-
LastUpdateDate: string
(date-time)
Read Only:
trueIndicates the date and time of the most recent update to the work order group. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64Indicates the user who made the most recent update to the work order group. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32Indicates the session login of the user who last updated the work order group. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
This number is used to implement optimistic locking, and it increments each time the row is updated. It's compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
-
OrganizationCode: string
Maximum Length:
18Abbreviation that identifies the inventory organization that's enabled for manufacturing. -
OrganizationId: integer
(int64)
Title:
OrganizationOrganization identifier that represents the plant to which this work order group belongs. -
OrganizationIdOrg: integer
(int64)
Read Only:
trueOrganization identifier that represents the plant to which this work order group is assigned. -
OrganizationName: string
Title:
OrganizationRead Only:trueMaximum Length:240Name of the inventory organization that's enabled for manufacturing. -
Status: string
Read Only:
trueMaximum Length:255Represents the status of the work order group. -
WoGroupId: integer
(int64)
Unique identifier for a work order group record, generated automatically by the application.
-
WorkOrderGroupDetail: array
Work Order Group Detail
Title:
Work Order Group DetailThe details of the group name and the work orders associated with it. -
WorkOrderGroupDFF: array
Flexfields for Work Order Group
Title:
Flexfields for Work Order GroupDescriptive flex fields that the work order group references.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Work Order Group Detail
Type:
arrayTitle:
Work Order Group DetailThe details of the group name and the work orders associated with it.
Show Source
Nested Schema : Flexfields for Work Order Group
Type:
arrayTitle:
Flexfields for Work Order GroupDescriptive flex fields that the work order group references.
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 : workOrderGroups-WorkOrderGroupDetail-item-response
Type:
Show Source
object-
AssetDescription: string
Read Only:
trueMaximum Length:255Asset Description of the asset associated with the maintenance work order. -
AssetNumber: string
Read Only:
trueMaximum Length:255Asset Number of the asset associated with the maintenance work order. -
CreatedBy: string
Read Only:
trueMaximum Length:64Indicates the details of the user who created the work order group. -
CreationDate: string
(date-time)
Read Only:
trueIndicates the date and time when the work order group details were created. -
InventoryItemId: integer
(int64)
Title:
ItemRead Only:trueValue that uniquely identifies the item, product, or assembly in the inventory organization. -
InventoryItemIdItemPEO: integer
(int64)
Title:
Item NumberRead Only:trueValue that uniquely identifies the item, product, or assembly in the inventory organization. -
ItemNumber: string
Title:
ItemRead Only:trueMaximum Length:300Number that identifies the item, which is an output of the work order. -
LastUpdateDate: string
(date-time)
Read Only:
trueIndicates the date and time of the most recent update to the work order group details. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64Indicates the user who made the most recent update to the work order group details. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32Indicates the session login of the user who last updated the work order group details. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Used to implement optimistic locking, this number increments each time the row is updated. It is then compared at the start and end of a transaction to detect if another session has updated the row since it was queried.
-
ObjectVersionNumberStatusPEO: integer
(int32)
Read Only:
trueNumber that identifies the object version that the work order status references. -
ObjectVersionNumberUnitOfMeasurePEO: integer
(int32)
Read Only:
trueNumber that identifies the object version that the unit of measure references. -
ObjectVersionNumberWEO: integer
(int32)
Read Only:
trueNumber that identifies the object version that the work order references. -
OrganizationId: integer
(int64)
Read Only:
trueThe organization identifier representing the plant to which this work order group belongs. -
OrganizationIdItemPEO: integer
(int64)
Title:
OrganizationRead Only:trueOrganization identifier that represents the plant to which this work order group belongs. -
PlannedCompletionDate: string
(date-time)
Title:
Completion DateRead Only:truePlanned date and time to finish the operation. The scheduling application sets this date. The planned completion date must not occur before the start date of the work order or after the finish date of the work order. This attribute is required. -
PlannedStartDate: string
(date-time)
Title:
Start DateRead Only:truePlanned date and time to start the operation. The scheduling application sets this date. The planned start date must not occur before the start date of the work order or after the finish date of the work order. This attribute is required. -
PlannedStartQuantity: number
Title:
QuantityRead Only:truePlanned production quantity for the work order. -
UnitOfMeasure: string
Title:
UOM NameRead Only:trueMaximum Length:25Unit of measure for the component quantity. -
UOMCode: string
Title:
UOMRead Only:trueMaximum Length:3Abbreviation that identifies the unit of measure that the material requirement uses. -
UOMCodeUnitofMeasurePEO: string
Title:
UOM CodeRead Only:trueMaximum Length:3Abbreviation that identifies the unit of measure that the material requirement uses. -
WoGroupDetailId: integer
(int64)
The unique identifier of a work order group detail record, generated automatically by the application.
-
WoGroupId: integer
(int64)
Represents the work order group identifier, which is the foreign key to the WIE_WORK_ORDER_GROUPS_B table.
-
WorkMethodCode: string
Read Only:
trueMaximum Length:30Abbreviation that identifies the unit of measure that the material requirement uses. -
WorkMethodId: integer
(int64)
Title:
Work MethodRead Only:trueRepresents the Work Method Identifier -
WorkOrderDescription: string
Title:
DescriptionRead Only:trueMaximum Length:240Description of the work order. -
WorkOrderId: integer
(int64)
Represents the internal identifier of the work order, which is the foreign key to the WIE_WORK_ORDERS_B table.
-
WorkOrderIdWEO: integer
(int64)
Read Only:
trueValue that uniquely identifies the work order. It is a primary key that the application generates when it creates the work order. This attribute is associated with a feature that requires opt in. -
WorkOrderNumber: string
Title:
Work OrderMaximum Length:120Number that identifies the work order. This number is unique in the manufacturing organization. The user can manually assign the number when the user creates the work order, or can allow the application to create a unique number from the numbering scheme defined by these plant parameters: Work Order Prefix or Work Order Starting Number. -
WorkOrderPriority: number
Title:
PriorityRead Only:truePriority to use when determining when to run the work order in relation to other work orders. -
WorkOrderStatusId: integer
(int64)
Title:
StatusRead Only:trueValue that uniquely identifies the work order status. A list of all the valid work order statuses can be retrieved using the workOrderStatuses resource. -
WorkOrderSubType: string
Title:
SubtypeRead Only:trueMaximum Length:30Description of the work being performed. Values include Standard Production, Prototyping, or Repair. -
WorkOrderType: string
Title:
TypeRead Only:trueMaximum Length:30Type of work order that the user selected when creating the work order. -
WorkOrderTypeMeaning: string
Title:
Work Order TypeRead Only:trueMaximum Length:255Type of work order selected by the user during its creation. -
WoStatusCode: string
Title:
Status CodeRead Only:trueMaximum Length:30Abbreviation that identifies the work order status. -
WoStatusId: integer
(int64)
Read Only:
trueValue that uniquely identifies the work order status. A list of all the valid work order statuses can be retrieved using the workOrderStatuses resource. -
WoStatusName: string
Title:
Work Order StatusRead Only:trueMaximum Length:120Name of the work order status. -
WoSystemStatusCode: string
Title:
System Status CodeRead Only:trueMaximum Length:30Abbreviation that identifies the system status mapped to the work order status by the application.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : workOrderGroups-WorkOrderGroupDFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:80Descriptive flexfield context name for work order groups. -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentDisplay value of the descriptive flexfield context for work order groups. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
WoGroupId: integer
(int64)
Unique identifier for a work order group record, automatically generated by the application.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source