Jump to

• Request
• Response

Perform load assignments for shipment lines and packing units

post

/fscmRestApi/resources/11.13.18.05/shipmentLineChangeRequests/action/loadAssignments

Assigns shipment lines and packing units to a load. Supported actions include assigning and unassigning them from a load, as well as automatically creating a load for shipment lines and packing units.

Request

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

• actionParameters: object actionParameters
  Additional Properties Allowed: additionalProperties

  List of attributes used for performing assignments to load.
• details: array details
  List of attributes used to specify the shipment lines or packing units on which the action is performed.

{
    "type":"object",
    "properties":{
        "actionParameters":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"List of attributes used for performing assignments to load.",
            "nullable":true
        },
        "details":{
            "type":"array",
            "description":"List of attributes used to specify the shipment lines or packing units on which the action is performed.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"string"
                }
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : actionParameters

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"List of attributes used for performing assignments to load.",
    "nullable":true
}

List of attributes used for performing assignments to load.

Nested Schema : details

Type: array

List of attributes used to specify the shipment lines or packing units on which the action is performed.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"List of attributes used to specify the shipment lines or packing units on which the action is performed.",
    "nullable":true,
    "items":{
        "type":"object",
        "additionalProperties":{
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Additional Properties Allowed

Show Source

• string

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

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): 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":"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":"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: string

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

Back to Top