Get one work order group

get

/fscmRestApi/resources/11.13.18.05/workOrderGroups/{WoGroupId}

Request

Path Parameters
Query Parameters
  • 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>
  • 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).
  • 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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
  • 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".
  • 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 Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : workOrderGroups-item-response
Type: object
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 : workOrderGroups-WorkOrderGroupDetail-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 255
    Asset Description of the asset associated with the maintenance work order.
  • Read Only: true
    Maximum Length: 255
    Asset Number of the asset associated with the maintenance work order.
  • Read Only: true
    Maximum Length: 64
    Indicates the details of the user who created the work order group.
  • Read Only: true
    Indicates the date and time when the work order group details were created.
  • Title: Item
    Read Only: true
    Value that uniquely identifies the item, product, or assembly in the inventory organization.
  • Title: Item Number
    Read Only: true
    Value that uniquely identifies the item, product, or assembly in the inventory organization.
  • Title: Item
    Read Only: true
    Maximum Length: 300
    Number that identifies the item, which is an output of the work order.
  • Read Only: true
    Indicates the date and time of the most recent update to the work order group details.
  • Read Only: true
    Maximum Length: 64
    Indicates the user who made the most recent update to the work order group details.
  • Read Only: true
    Maximum Length: 32
    Indicates the session login of the user who last updated the work order group details.
  • Links
  • 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.
  • Read Only: true
    Number that identifies the object version that the work order status references.
  • Read Only: true
    Number that identifies the object version that the unit of measure references.
  • Read Only: true
    Number that identifies the object version that the work order references.
  • Read Only: true
    The organization identifier representing the plant to which this work order group belongs.
  • Title: Organization
    Read Only: true
    Organization identifier that represents the plant to which this work order group belongs.
  • 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.
  • 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.
  • Title: Quantity
    Read Only: true
    Planned production quantity for the work order.
  • Title: UOM Name
    Read Only: true
    Maximum Length: 25
    Unit of measure for the component quantity.
  • Title: UOM
    Read Only: true
    Maximum Length: 3
    Abbreviation that identifies the unit of measure that the material requirement uses.
  • Title: UOM Code
    Read Only: true
    Maximum Length: 3
    Abbreviation that identifies the unit of measure that the material requirement uses.
  • The unique identifier of a work order group detail record, generated automatically by the application.
  • Represents the work order group identifier, which is the foreign key to the WIE_WORK_ORDER_GROUPS_B table.
  • Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the unit of measure that the material requirement uses.
  • Title: Work Method
    Read Only: true
    Represents the Work Method Identifier
  • Title: Description
    Read Only: true
    Maximum Length: 240
    Description of the work order.
  • Represents the internal identifier of the work order, which is the foreign key to the WIE_WORK_ORDERS_B table.
  • 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.
  • 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.
  • Title: Priority
    Read Only: true
    Priority to use when determining when to run the work order in relation to other work orders.
  • 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.
  • Title: Subtype
    Read Only: true
    Maximum Length: 30
    Description of the work being performed. Values include Standard Production, Prototyping, or Repair.
  • Title: Type
    Read Only: true
    Maximum Length: 30
    Type of work order that the user selected when creating the work order.
  • Title: Work Order Type
    Read Only: true
    Maximum Length: 255
    Type of work order selected by the user during its creation.
  • Title: Status Code
    Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the work order 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.
  • Title: Work Order Status
    Read Only: true
    Maximum Length: 120
    Name of the work order status.
  • 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 : workOrderGroups-WorkOrderGroupDFF-item-response
Type: object
Show Source
Back to Top