Get one work order group
get
/fscmRestApi/resources/11.13.18.05/workOrderGroups/{WoGroupId}
Request
Path Parameters
-
WoGroupId(required): integer(int64)
Unique identifier for a work order group record, generated automatically by the application.
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: 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-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
Indicates the user who created the work order group. -
CreationDate: string
(date-time)
Read Only:
true
Indicates the date and time when the work order group was created. -
GroupCode: string
Title:
Group Code
Maximum Length:30
Represents the user key for the work order group entity. -
GroupDescription: string
Title:
Group Description
Maximum Length:240
Description of the work order group. -
GroupName: string
Maximum Length:
120
Name of the work order group. -
GroupSource: string
Title:
Group Source
Maximum Length:30
Default Value:ORA_MANUFACTURING
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)
Date when the work order group becomes inactive.
-
LastUpdateDate: string
(date-time)
Read Only:
true
Indicates the date and time of the most recent update to the work order group. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Indicates the user who made the most recent update to the work order group. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Indicates the session login of the user who last updated the work order group. -
links: array
Links
Title:
Links
The 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:
18
Abbreviation that identifies the inventory organization that's enabled for manufacturing. -
OrganizationId: integer
(int64)
Title:
Organization
Organization identifier that represents the plant to which this work order group belongs. -
OrganizationIdOrg: integer
(int64)
Read Only:
true
Organization identifier that represents the plant to which this work order group is assigned. -
OrganizationName: string
Title:
Organization
Read Only:true
Maximum Length:240
Name of the inventory organization that's enabled for manufacturing. -
Status: string
Read Only:
true
Maximum Length:255
Represents 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 Detail
The details of the group name and the work orders associated with it. -
WorkOrderGroupDFF: array
Flexfields for Work Order Group
Title:
Flexfields for Work Order Group
Descriptive flex fields that the work order group references.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Work Order Group Detail
Type:
array
Title:
Work Order Group Detail
The details of the group name and the work orders associated with it.
Show Source
Nested Schema : Flexfields for Work Order Group
Type:
array
Title:
Flexfields for Work Order Group
Descriptive flex fields that the work order group references.
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 : workOrderGroups-WorkOrderGroupDetail-item-response
Type:
Show Source
object
-
AssetDescription: string
Read Only:
true
Maximum Length:255
Asset Description of the asset associated with the maintenance work order. -
AssetNumber: string
Read Only:
true
Maximum Length:255
Asset Number of the asset associated with the maintenance work order. -
CreatedBy: string
Read Only:
true
Maximum Length:64
Indicates the details of the user who created the work order group. -
CreationDate: string
(date-time)
Read Only:
true
Indicates the date and time when the work order group details were created. -
InventoryItemId: integer
(int64)
Title:
Item
Read Only:true
Value that uniquely identifies the item, product, or assembly in the inventory organization. -
InventoryItemIdItemPEO: integer
(int64)
Title:
Item Number
Read Only:true
Value that uniquely identifies the item, product, or assembly in the inventory organization. -
ItemNumber: string
Title:
Item
Read Only:true
Maximum Length:300
Number that identifies the item, which is an output of the work order. -
LastUpdateDate: string
(date-time)
Read Only:
true
Indicates the date and time of the most recent update to the work order group details. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Indicates the user who made the most recent update to the work order group details. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Indicates the session login of the user who last updated the work order group details. -
links: array
Links
Title:
Links
The 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:
true
Number that identifies the object version that the work order status references. -
ObjectVersionNumberUnitOfMeasurePEO: integer
(int32)
Read Only:
true
Number that identifies the object version that the unit of measure references. -
ObjectVersionNumberWEO: integer
(int32)
Read Only:
true
Number that identifies the object version that the work order references. -
OrganizationId: integer
(int64)
Read Only:
true
The organization identifier representing the plant to which this work order group belongs. -
OrganizationIdItemPEO: integer
(int64)
Title:
Organization
Read Only:true
Organization identifier that represents the plant to which this work order group belongs. -
PlannedCompletionDate: string
(date-time)
Title:
Completion Date
Read Only:true
Planned 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 Date
Read Only:true
Planned 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:
Quantity
Read Only:true
Planned production quantity for the work order. -
UnitOfMeasure: string
Title:
UOM Name
Read Only:true
Maximum Length:25
Unit of measure for the component quantity. -
UOMCode: string
Title:
UOM
Read Only:true
Maximum Length:3
Abbreviation that identifies the unit of measure that the material requirement uses. -
UOMCodeUnitofMeasurePEO: string
Title:
UOM Code
Read Only:true
Maximum Length:3
Abbreviation 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:
true
Maximum Length:30
Abbreviation that identifies the unit of measure that the material requirement uses. -
WorkMethodId: integer
(int64)
Title:
Work Method
Read Only:true
Represents the Work Method Identifier -
WorkOrderDescription: string
Title:
Description
Read Only:true
Maximum Length:240
Description 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:
true
Value 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 Order
Maximum Length:120
Number 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:
Priority
Read Only:true
Priority to use when determining when to run the work order in relation to other work orders. -
WorkOrderStatusId: integer
(int64)
Title:
Status
Read Only:true
Value 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:
Subtype
Read Only:true
Maximum Length:30
Description of the work being performed. Values include Standard Production, Prototyping, or Repair. -
WorkOrderType: string
Title:
Type
Read Only:true
Maximum Length:30
Type of work order that the user selected when creating the work order. -
WorkOrderTypeMeaning: string
Title:
Work Order Type
Read Only:true
Maximum Length:255
Type of work order selected by the user during its creation. -
WoStatusCode: string
Title:
Status Code
Read Only:true
Maximum Length:30
Abbreviation that identifies the work order status. -
WoStatusId: integer
(int64)
Read Only:
true
Value 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 Status
Read Only:true
Maximum Length:120
Name of the work order status. -
WoSystemStatusCode: string
Title:
System Status Code
Read Only:true
Maximum Length:30
Abbreviation that identifies the system status mapped to the work order status by the application.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : workOrderGroups-WorkOrderGroupDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:80
Descriptive flexfield context name for work order groups. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Display value of the descriptive flexfield context for work order groups. -
links: array
Links
Title:
Links
The 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:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- WorkOrderGroupDFF
-
Parameters:
- WoGroupId:
$request.path.WoGroupId
Descriptive flex fields that the work order group references. - WoGroupId:
- WorkOrderGroupDetail
-
Operation: /fscmRestApi/resources/11.13.18.05/workOrderGroups/{WoGroupId}/child/WorkOrderGroupDetailParameters:
- WoGroupId:
$request.path.WoGroupId
The details of the group name and the work orders associated with it. - WoGroupId: