Jump to

• Request
• Response

Get a By Mode

get

/bulkPlans/{bulkPlanGid}/partitions/{partitionGid}/byModes/{transportModeGid}

Request

Path Parameters

• bulkPlanGid(required): string
  Resource ID
• partitionGid(required): string
  Resource ID
• transportModeGid(required): string
  Resource ID

Query Parameters

• expand: string
  Comma-delimited string of child resource names that you want to expand so that the contents return with the parent in the same GET request.
• fields: string
  Comma-delimited string of field names that you wanted returned in a GET request.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/vnd.oracle.resource+json;type=singular

Default Response

Default Response.

Body ()

Root Schema : bulkPlans.partitions.byModes

Type: object

Show Source

• domainName: string
  No description.
• links: array links
  Read Only: true
• numOrderMovementsPlanned: number (int32)
  No description.
• numOrdersPlanned: number (int32)
  No description.
• numShipmentsBuilt: number (int32)
  No description.
• totalCost: totalCost
  No description.
• totalDistance: totalDistance
  No description.
• totalNumStops: number (int32)
  No description.
• totalShipmentTimeSecs: totalShipmentTimeSecs
  No description.
• totalVolume: totalVolume
  No description.
• totalVolumeCapacity: totalVolumeCapacity
  No description.
• totalWeight: totalWeight
  No description.
• totalWeightCapacity: totalWeightCapacity
  No description.
• transportModeGid: string
  No description.

{
    "properties":{
        "transportModeGid":{
            "description":"No description.",
            "type":"string"
        },
        "numOrdersPlanned":{
            "description":"No description.",
            "type":"number",
            "format":"int32"
        },
        "numOrderMovementsPlanned":{
            "description":"No description.",
            "type":"number",
            "format":"int32"
        },
        "totalCost":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "totalNumStops":{
            "description":"No description.",
            "type":"number",
            "format":"int32"
        },
        "totalWeight":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "totalVolume":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "totalDistance":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "numShipmentsBuilt":{
            "description":"No description.",
            "type":"number",
            "format":"int32"
        },
        "totalShipmentTimeSecs":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "totalWeightCapacity":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "totalVolumeCapacity":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : totalCost

No description.

Match All

Show Source

• object currencyType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : totalDistance

No description.

Match All

Show Source

• object amountType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : totalShipmentTimeSecs

No description.

Match All

Show Source

• object amountType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : totalVolume

No description.

Match All

Show Source

• object amountType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : totalVolumeCapacity

No description.

Match All

Show Source

• object amountType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : totalWeight

No description.

Match All

Show Source

• object amountType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : totalWeightCapacity

No description.

Match All

Show Source

• object amountType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : links

Type: object

Show Source

• href: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

Nested Schema : currencyType

Type: object

Show Source

• currency: string
  ISO 4217 currency code
• value: number
  Numeric value that specifies a currency

{
    "properties":{
        "value":{
            "description":"Numeric value that specifies a currency",
            "type":"number"
        },
        "currency":{
            "description":"ISO 4217 currency code",
            "type":"string"
        }
    }
}

Nested Schema : amountType

Type: object

Show Source

• unit: string
  Unit of measure
• value: number
  Numeric value that specifies an amount

{
    "properties":{
        "value":{
            "description":"Numeric value that specifies an amount",
            "type":"number"
        },
        "unit":{
            "description":"Unit of measure",
            "type":"string"
        }
    }
}

Back to Top