Jump to

• Request
• Response

Create work order group details

post

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

Request

Path Parameters

• WoGroupId(required): integer(int64)
  Unique identifier for a work order group record, generated automatically by the application.

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.
• Upsert-Mode: string
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.
• 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.
• WorkOrderId: integer (int64)
  Represents the internal identifier of the work order, which is the foreign key to the WIE_WORK_ORDERS_B table.
• 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.

{
    "type":"object",
    "properties":{
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "WoGroupDetailId":{
            "type":"integer",
            "description":"The unique identifier of a work order group detail record, generated automatically by the application.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "WoGroupId":{
            "type":"integer",
            "description":"Represents the work order group identifier, which is the foreign key to the WIE_WORK_ORDER_GROUPS_B table.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "WorkOrderId":{
            "type":"integer",
            "description":"Represents the internal identifier of the work order, which is the foreign key to the WIE_WORK_ORDERS_B table.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "WorkOrderNumber":{
            "title":"Work Order",
            "maxLength":120,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

Back to Top

Response

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.

Body ()

Root Schema : workOrderGroups-WorkOrderGroupDetail-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "AssetDescription":{
            "maxLength":255,
            "type":"string",
            "description":"Asset Description of the asset associated with the maintenance work order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssetNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Asset Number of the asset associated with the maintenance work order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Indicates the details of the user who created the work order group.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Indicates the date and time when the work order group details were created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "title":"Item",
            "type":"integer",
            "description":"Value that uniquely identifies the item, product, or assembly in the inventory organization.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InventoryItemIdItemPEO":{
            "title":"Item Number",
            "type":"integer",
            "description":"Value that uniquely identifies the item, product, or assembly in the inventory organization.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            },
            "x-queryable":true
        },
        "ItemNumber":{
            "title":"Item",
            "maxLength":300,
            "type":"string",
            "description":"Number that identifies the item, which is an output of the work order.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Indicates the date and time of the most recent update to the work order group details.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Indicates the session login of the user who last updated the work order group details.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Indicates the user who made the most recent update to the work order group details.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ObjectVersionNumberStatusPEO":{
            "type":"integer",
            "description":"Number that identifies the object version that the work order status references.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":9
            },
            "x-queryable":true
        },
        "ObjectVersionNumberUnitOfMeasurePEO":{
            "type":"integer",
            "description":"Number that identifies the object version that the unit of measure references.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":9
            }
        },
        "ObjectVersionNumberWEO":{
            "type":"integer",
            "description":"Number that identifies the object version that the work order references.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":9
            },
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"The organization identifier representing the plant to which this work order group belongs.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrganizationIdItemPEO":{
            "title":"Organization",
            "type":"integer",
            "description":"Organization identifier that represents the plant to which this work order group belongs.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            },
            "x-queryable":true
        },
        "PlannedCompletionDate":{
            "title":"Completion Date",
            "type":"string",
            "description":"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.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlannedStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"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.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlannedStartQuantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Planned production quantity for the work order.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UOMCode":{
            "title":"UOM",
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure that the material requirement uses.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "UOMCodeUnitofMeasurePEO":{
            "title":"UOM Code",
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure that the material requirement uses.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "title":"UOM Name",
            "maxLength":25,
            "type":"string",
            "description":"Unit of measure for the component quantity.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"edit"
            },
            "x-queryable":true
        },
        "WoGroupDetailId":{
            "type":"integer",
            "description":"The unique identifier of a work order group detail record, generated automatically by the application.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "WoGroupId":{
            "type":"integer",
            "description":"Represents the work order group identifier, which is the foreign key to the WIE_WORK_ORDER_GROUPS_B table.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "WoStatusCode":{
            "title":"Status Code",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the work order status.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WoStatusId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work order status. A list of all the valid work order statuses can be retrieved using the workOrderStatuses resource.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "WoStatusName":{
            "title":"Work Order Status",
            "maxLength":120,
            "type":"string",
            "description":"Name of the work order status.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WoSystemStatusCode":{
            "title":"System Status Code",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the system status mapped to the work order status by the application.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkMethodCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure that the material requirement uses.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkMethodId":{
            "title":"Work Method",
            "type":"integer",
            "description":"Represents the Work Method Identifier",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Work Method"
                },
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "WorkOrderDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the work order.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Description"
                },
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "WorkOrderId":{
            "type":"integer",
            "description":"Represents the internal identifier of the work order, which is the foreign key to the WIE_WORK_ORDERS_B table.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "WorkOrderIdWEO":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "WorkOrderNumber":{
            "title":"Work Order",
            "maxLength":120,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "WorkOrderPriority":{
            "title":"Priority",
            "type":"number",
            "description":"Priority to use when determining when to run the work order in relation to other work orders.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkOrderStatusId":{
            "title":"Status",
            "type":"integer",
            "description":"Value that uniquely identifies the work order status. A list of all the valid work order statuses can be retrieved using the workOrderStatuses resource.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Status"
                },
                "precision":18
            },
            "x-queryable":true
        },
        "WorkOrderSubType":{
            "title":"Subtype",
            "maxLength":30,
            "type":"string",
            "description":"Description of the work being performed. Values include Standard Production, Prototyping, or Repair.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Subtype"
                }
            },
            "x-queryable":true
        },
        "WorkOrderType":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Type of work order that the user selected when creating the work order.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkOrderTypeMeaning":{
            "title":"Work Order Type",
            "maxLength":255,
            "type":"string",
            "description":"Type of work order selected by the user during its creation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top