REST API for Oracle Supply Chain Management Cloud

Change transportation plan for shipment lines

post

/fscmRestApi/resources/11.13.18.05/shipmentLineChangeRequests/action/changeTransportationPlan

Changes the transportation plan for the specified shipment lines.

Request

Header Parameters

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.

Supported Media Types

application/vnd.oracle.adf.action+json

Root Schema : schema

Type: object

Show Source

shipmentLines: array shipmentLines

Contains a list of ShipmentLine attributes. ShipmentLine: Value that uniquely identifies the shipment line whose transportation plan is to be changed.
transportationShipmentDetails: object transportationShipmentDetails

Additional Properties Allowed: additionalProperties

List of attributes used for updating the transportation plan. TransportationShipment: Value that identifies the planned shipment that the transportation management application provides. TransportationShipmentLine: Value that identifies the planned shipment line that the transportation management application provides. ScheduledShipDate: Date when the shipment line is scheduled to ship. InitialDestinationId : Value that uniquely identifies the first leg of transportation that the transportation management application planned to deliver the shipment to the final destination. ShipMethodCode: Transportation method for the shipment line.

{
    "type":"object",
    "properties":{
        "shipmentLines":{
            "type":"array",
            "description":"Contains a list of ShipmentLine attributes.\nShipmentLine: Value that uniquely identifies the shipment line whose transportation plan is to be changed.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"string"
                }
            }
        },
        "transportationShipmentDetails":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"List of attributes used for updating the transportation plan.\nTransportationShipment: Value that identifies the planned shipment that the transportation management application provides.\nTransportationShipmentLine: Value that identifies the planned shipment line that the transportation management application provides.\nScheduledShipDate: Date when the shipment line is scheduled to ship.\nInitialDestinationId : Value that uniquely identifies the first leg of transportation that the transportation management application planned to deliver the shipment to the final destination.\nShipMethodCode: Transportation method for the shipment line.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : shipmentLines

Type: array

Contains a list of ShipmentLine attributes. ShipmentLine: Value that uniquely identifies the shipment line whose transportation plan is to be changed.

Show Source

Array of: object items

Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"Contains a list of ShipmentLine attributes.\nShipmentLine: Value that uniquely identifies the shipment line whose transportation plan is to be changed.",
    "nullable":true,
    "items":{
        "type":"object",
        "additionalProperties":{
            "type":"string"
        }
    }
}

Nested Schema : transportationShipmentDetails

Type: object

Additional Properties Allowed

Show Source

string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"List of attributes used for updating the transportation plan.\nTransportationShipment: Value that identifies the planned shipment that the transportation management application provides.\nTransportationShipmentLine: Value that identifies the planned shipment line that the transportation management application provides.\nScheduledShipDate: Date when the shipment line is scheduled to ship.\nInitialDestinationId : Value that uniquely identifies the first leg of transportation that the transportation management application planned to deliver the shipment to the final destination.\nShipMethodCode: Transportation method for the shipment line.",
    "nullable":true
}

List of attributes used for updating the transportation plan. TransportationShipment: Value that identifies the planned shipment that the transportation management application provides. TransportationShipmentLine: Value that identifies the planned shipment line that the transportation management application provides. ScheduledShipDate: Date when the shipment line is scheduled to ship. InitialDestinationId : Value that uniquely identifies the first leg of transportation that the transportation management application planned to deliver the shipment to the final destination. ShipMethodCode: Transportation method for the shipment line.

Nested Schema : items

Type: object

Additional Properties Allowed

Show Source

string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Response

Supported Media Types

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

Default Response

The following table describes the default response for this task.

Root Schema : schema

Type: object

Show Source

result(required): object result

Additional Properties Allowed: additionalProperties

Result of processing the request, which includes the processing status, and a list of messages, if any.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"string"
                    }
                }
            },
            "description":"Result of processing the request, which includes the processing status, and a list of messages, if any."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

array additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        }
    },
    "description":"Result of processing the request, which includes the processing status, and a list of messages, if any."
}

Result of processing the request, which includes the processing status, and a list of messages, if any.

Nested Schema : additionalProperties

Type: array

Show Source

Array of: object items

Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "items":{
        "type":"object",
        "additionalProperties":{
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Additional Properties Allowed

Show Source

string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}