Jump to

• Request
• Response

Update work orders

post

/fscmRestApi/resources/11.13.18.05/productionSchedulingPlans/{PlanId}/action/updateWorkOrders

Request to update work order properties to facilitate mass editing work orders.

Request

Path Parameters

• PlanId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

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.

Supported Media Types

• application/vnd.oracle.adf.action+json

Request Body - application/vnd.oracle.adf.action+json ()

Root Schema : schema

Type: object

Show Source

• clearEarliestStartDate: boolean
  Contains one of the following values: true or false. If true, then earliest start date is removed. If false, then the earliest start date remains as specified.
• clearTargetCompletionDate: boolean
  Contains one of the following values: true or false. If true, then the target completion date is removed. If false, then the target completion date remains as specified.
• earliestStartDate: string
  Date and time when a work order can't be scheduled before.
• firmPlanned: boolean
  Contains one of the following values: true or false. If true, then the work order is set to firm. If false, then the work order firm property is removed.
• onHold: boolean
  Contains one of the following values: true or false. If true, then the work order isn't scheduled. If false, then the work order is scheduled.
• selectedForRelease: boolean
  Contains one of the following values: true or false. If true, then the work order is selected for release. If false, then the work order isn't selected for release.
• targetCompletionDate: string
  Date and time when a work order is desired to be completed.
• workOrderIds: array workOrderIds
  List of work order unique identifiers.

{
    "type":"object",
    "properties":{
        "selectedForRelease":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the work order is selected for release. If false, then the work order isn't selected for release.",
            "nullable":true
        },
        "clearTargetCompletionDate":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the target completion date is removed. If false, then the target completion date remains as specified.",
            "nullable":true
        },
        "workOrderIds":{
            "type":"array",
            "description":"List of work order unique identifiers.",
            "nullable":true,
            "items":{
                "type":"number"
            }
        },
        "onHold":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the work order isn't scheduled. If false, then the work order is scheduled.",
            "nullable":true
        },
        "firmPlanned":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the work order is set to firm. If false, then the work order firm property is removed.",
            "nullable":true
        },
        "targetCompletionDate":{
            "type":"string",
            "description":"Date and time when a work order is desired to be completed.",
            "nullable":true
        },
        "earliestStartDate":{
            "type":"string",
            "description":"Date and time when a work order can't be scheduled before.",
            "nullable":true
        },
        "clearEarliestStartDate":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then earliest start date is removed. If false, then the earliest start date remains as specified.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : workOrderIds

Type: array

List of work order unique identifiers.

Show Source

• Array of: number

{
    "type":"array",
    "description":"List of work order unique identifiers.",
    "nullable":true,
    "items":{
        "type":"number"
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.adf.actionresult+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : schema

Type: object

Show Source

• result(required): number
  If the request is successful, then the action returns the number of work order records updated.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"number",
            "description":"If the request is successful, then the action returns the number of work order records updated."
        }
    },
    "additionalProperties":false
}

Back to Top