Jump to

• Request
• Response
• Examples

Unpack shipment lines or packing units

post

/fscmRestApi/resources/11.13.18.05/shipmentLineChangeRequests/action/unpack

Unpacks shipment lines or packing units from their parent parent unit.

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

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

Root Schema : schema

Type: object

Show Source

• linesToUnpack: array linesToUnpack
  Contains the attribute used for specifying shipment lines to be packed. ShipmentLine: Value that uniquely identifies the shipment line to be packed.
• packingUnitsToUnpack: array packingUnitsToUnpack
  List of attributes used for specifying the packing units to be unpacked. PackingUnit: Name of the packing unit to be unpacked. PackingUnitId: Value that uniquely identifies the packing unit to be unpacked.

{
    "type":"object",
    "properties":{
        "linesToUnpack":{
            "type":"array",
            "description":"Contains the attribute used for specifying shipment lines to be packed. \nShipmentLine: Value that uniquely identifies the shipment line to be packed.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"string"
                }
            }
        },
        "packingUnitsToUnpack":{
            "type":"array",
            "description":"List of attributes used for specifying the packing units to be unpacked.\nPackingUnit: Name of the packing unit to be unpacked.\nPackingUnitId: Value that uniquely identifies the packing unit to be unpacked.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"string"
                }
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : linesToUnpack

Type: array

Contains the attribute used for specifying shipment lines to be packed. ShipmentLine: Value that uniquely identifies the shipment line to be packed.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"Contains the attribute used for specifying shipment lines to be packed. \nShipmentLine: Value that uniquely identifies the shipment line to be packed.",
    "nullable":true,
    "items":{
        "type":"object",
        "additionalProperties":{
            "type":"string"
        }
    }
}

Nested Schema : packingUnitsToUnpack

Type: array

List of attributes used for specifying the packing units to be unpacked. PackingUnit: Name of the packing unit to be unpacked. PackingUnitId: Value that uniquely identifies the packing unit to be unpacked.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"List of attributes used for specifying the packing units to be unpacked.\nPackingUnit: Name of the packing unit to be unpacked.\nPackingUnitId: Value that uniquely identifies the packing unit to be unpacked.",
    "nullable":true,
    "items":{
        "type":"object",
        "additionalProperties":{
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Additional Properties Allowed

Show Source

• string

{
    "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 error message, if any.

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

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Result of processing the request, which includes the processing status and error message, if any."
}

Result of processing the request, which includes the processing status and error message, if any.

Back to Top

Examples

This example describes how to unpack shipment lines and packing units.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/shipmentLineChangeRequests"

Example 1 Request Body

The following example includes the contents of the request body in JSON format to unpack shipment lines from the current packing unit. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.

{
    "name": "unpack",
    "parameters": [
        {
            "linesToUnpack": [
                {
                     
                    "ShipmentLine": 3993948
                },
                {
                    "ShipmentLine": 3993950
                }
            ]
        }      
    ]
}

Example 1 Response Body

The following example includes the contents of the response body in JSON format:

{
    "result": {
        "Message": null,
        "ReturnStatus": "S"
    }
}

Example 2 Request Body

The following example includes the contents of the request body in JSON format unpack the packing unit from the current outer packing unit. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.

{
    "name": "unpack",
    "parameters": [
        {
            "packingUnitsToUnpack": [
                {
                    "PackingUnit": "50325"
                }
            ]
        }      
    ]
}

Example 2 Response Body

The following example includes the contents of the response body in JSON format:

{
    "result": {
        "Message": null,
        "ReturnStatus": "S"
    }
}

Back to Top