Jump to

• Request
• Response

Get a Fleet Bulk Plan

get

/fleetBulkPlans/{fleetBulkPlanGid}

Request

Path Parameters

• fleetBulkPlanGid(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 : fleetBulkPlans

Type: object

Show Source

• afterShipCost: afterShipCost
  No description.
• appMachineGid: string
  No description.
• bobtailDist: bobtailDist
  No description.
• costs: costs
• deadheadDist: deadheadDist
  No description.
• description: string
  No description.
• domainName: string
  No description.
• endTime: endTime
  No description.
• fleetBulkPlanGid: string
  No description.
• fleetBulkPlanXid: string
  No description.
• insertDate: insertDate
  Read Only: true

  insert date
• links: array links
  Read Only: true
• loadedDist: loadedDist
  No description.
• logProcessId: number (int64)
  No description.
• numOfResourcesAssignable: number (int32)
  No description.
• numOfResourcesAssigned: number (int32)
  No description.
• numOfResourcesSelected: number (int32)
  No description.
• numOfShipmentsAssignable: number (int32)
  No description.
• numOfShipmentsAssigned: number (int32)
  No description.
• numOfShipmentsFailed: number (int32)
  No description.
• numOfShipmentsSelected: number (int32)
  No description.
• numResrcWithMultiAssign: number (int32)
  No description.
• parameterSetGid: string
  No description.
• preShipCost: preShipCost
  No description.
• resourceQueryName: string
  No description.
• resourceType: string
  No description.
• shipmentQueryName: string
  No description.
• startTime: startTime
  No description.
• state: string
  No description.
• terminationReason: string
  No description.
• terminationTime: terminationTime
  No description.
• terminationUser: string
  No description.
• updateDate: updateDate
  Read Only: true

  update date

{
    "properties":{
        "fleetBulkPlanGid":{
            "description":"No description.",
            "type":"string"
        },
        "fleetBulkPlanXid":{
            "description":"No description.",
            "type":"string"
        },
        "shipmentQueryName":{
            "description":"No description.",
            "type":"string"
        },
        "resourceQueryName":{
            "description":"No description.",
            "type":"string"
        },
        "startTime":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "endTime":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "numOfShipmentsSelected":{
            "description":"No description.",
            "type":"number",
            "format":"int32"
        },
        "resourceType":{
            "description":"No description.",
            "type":"string"
        },
        "numOfResourcesSelected":{
            "description":"No description.",
            "type":"number",
            "format":"int32"
        },
        "numOfShipmentsAssignable":{
            "description":"No description.",
            "type":"number",
            "format":"int32"
        },
        "numOfResourcesAssignable":{
            "description":"No description.",
            "type":"number",
            "format":"int32"
        },
        "numResrcWithMultiAssign":{
            "description":"No description.",
            "type":"number",
            "format":"int32"
        },
        "numOfShipmentsAssigned":{
            "description":"No description.",
            "type":"number",
            "format":"int32"
        },
        "numOfResourcesAssigned":{
            "description":"No description.",
            "type":"number",
            "format":"int32"
        },
        "preShipCost":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "afterShipCost":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "bobtailDist":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "loadedDist":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "deadheadDist":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "description":{
            "description":"No description.",
            "type":"string"
        },
        "parameterSetGid":{
            "description":"No description.",
            "type":"string"
        },
        "state":{
            "description":"No description.",
            "type":"string"
        },
        "logProcessId":{
            "description":"No description.",
            "type":"number",
            "format":"int64"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "numOfShipmentsFailed":{
            "description":"No description.",
            "type":"number",
            "format":"int32"
        },
        "appMachineGid":{
            "description":"No description.",
            "type":"string"
        },
        "terminationTime":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "terminationUser":{
            "description":"No description.",
            "type":"string"
        },
        "terminationReason":{
            "description":"No description.",
            "type":"string"
        },
        "updateDate":{
            "description":"update date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "insertDate":{
            "description":"insert date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "costs":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/fleetBulkPlans.costs"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : afterShipCost

No description.

Match All

Show Source

• object currencyType

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

Nested Schema : bobtailDist

No description.

Match All

Show Source

• object amountType

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

Nested Schema : costs

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

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

Nested Schema : deadheadDist

No description.

Match All

Show Source

• object amountType

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

Nested Schema : endTime

No description.

Match All

Show Source

• object dateTimeType

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

Nested Schema : insertDate

Read Only: true

insert date

Match All

Show Source

• object dateType

{
    "description":"insert date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "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 : loadedDist

No description.

Match All

Show Source

• object amountType

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

Nested Schema : preShipCost

No description.

Match All

Show Source

• object currencyType

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

Nested Schema : startTime

No description.

Match All

Show Source

• object dateTimeType

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

Nested Schema : terminationTime

No description.

Match All

Show Source

• object dateTimeType

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

Nested Schema : updateDate

Read Only: true

update date

Match All

Show Source

• object dateType

{
    "description":"update date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

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"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object fleetBulkPlans.costs

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/fleetBulkPlans.costs"
    }
}

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 : fleetBulkPlans.costs

Type: object

Show Source

• afterCost: afterCost
  No description.
• costCategoryGid: string
  No description.
• domainName: string
  No description.
• links: array links
  Read Only: true
• preCost: preCost
  No description.

{
    "properties":{
        "costCategoryGid":{
            "description":"No description.",
            "type":"string"
        },
        "preCost":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "afterCost":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : afterCost

No description.

Match All

Show Source

• object currencyType

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

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 : preCost

No description.

Match All

Show Source

• object currencyType

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

Nested Schema : links

Type: object

Show Source

• href: string
• rel: string

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

Nested Schema : dateTimeType

Type: object

Show Source

• timezone: string
  Timezone in Olson database format
• value: string (date-time)
  Date in ISO 8601 format

{
    "properties":{
        "value":{
            "description":"Date in ISO 8601 format",
            "type":"string",
            "format":"date-time"
        },
        "timezone":{
            "description":"Timezone in Olson database format",
            "type":"string"
        }
    }
}

Nested Schema : dateType

Type: object

Show Source

• value: string (date-time)
  Date in ISO 8601 format

{
    "properties":{
        "value":{
            "description":"Date in ISO 8601 format",
            "type":"string",
            "format":"date-time"
        }
    }
}

Back to Top