Jump to

• Request
• Response

Create a Capacity Override

post

/itineraries/{itineraryGid}/legs/{legGid}/capacityOverrides

Request

Path Parameters

• itineraryGid(required): string
  Resource ID
• legGid(required): string
  Resource ID

Supported Media Types

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

Request Body - application/vnd.oracle.resource+json;type=collection ()

Root Schema : schema

Type: object

Show Source

• items(required): array items

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/itineraries.legs.capacityOverrides"
            }
        }
    },
    "required":[
        "items"
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itineraries.legs.capacityOverrides"
    }
}

Nested Schema : schema

Type: object

Show Source

• capacityOverrideGid: string
  The GID for the capacity override details related to this itinerary leg. The capacity override allows you to model specific weight/volume restrictions by transport mode or equipment that can be assigned to any itinerary leg to control whether a shipment can be planned for that leg. For example, some countries or regions have specific capacity restrictions such as bridges that have maximum weight limits. By creating a capacity override and assigning it to a specific itinerary leg, Oracle Transportation Management will override the equipment capacity. For example, if an equipment has a capacity of 30000 pounds, but the capacity override says 27000 pounds, then the system will not plan more than 27000 pounds in the equipment.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true

{
    "properties":{
        "capacityOverrideGid":{
            "description":"The GID for the capacity override details related to this itinerary leg. The capacity override allows you to model specific weight/volume restrictions by transport mode or equipment that can be assigned to any itinerary leg to control whether a shipment can be planned for that leg. For example, some countries or regions have specific capacity restrictions such as bridges that have maximum weight limits. By creating a capacity override and assigning it to a specific itinerary leg, Oracle Transportation Management will override the equipment capacity. For example, if an equipment has a capacity of 30000 pounds, but the capacity override says 27000 pounds, then the system will not plan more than 27000 pounds in the equipment.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "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 : links

Type: object

Show Source

• href: string
• rel: string

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

Request Body - application/vnd.oracle.resource+json;type=singular ()

Root Schema : schema

Type: object

Show Source

• capacityOverrideGid: string
  The GID for the capacity override details related to this itinerary leg. The capacity override allows you to model specific weight/volume restrictions by transport mode or equipment that can be assigned to any itinerary leg to control whether a shipment can be planned for that leg. For example, some countries or regions have specific capacity restrictions such as bridges that have maximum weight limits. By creating a capacity override and assigning it to a specific itinerary leg, Oracle Transportation Management will override the equipment capacity. For example, if an equipment has a capacity of 30000 pounds, but the capacity override says 27000 pounds, then the system will not plan more than 27000 pounds in the equipment.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true

{
    "properties":{
        "capacityOverrideGid":{
            "description":"The GID for the capacity override details related to this itinerary leg. The capacity override allows you to model specific weight/volume restrictions by transport mode or equipment that can be assigned to any itinerary leg to control whether a shipment can be planned for that leg. For example, some countries or regions have specific capacity restrictions such as bridges that have maximum weight limits. By creating a capacity override and assigning it to a specific itinerary leg, Oracle Transportation Management will override the equipment capacity. For example, if an equipment has a capacity of 30000 pounds, but the capacity override says 27000 pounds, then the system will not plan more than 27000 pounds in the equipment.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "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 : links

Type: object

Show Source

• href: string
• rel: string

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

Back to Top

Response

Supported Media Types

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

Default Response

Default Response.

Body ()

Root Schema : schema

Type: object

Show Source

• capacityOverrideGid: string
  The GID for the capacity override details related to this itinerary leg. The capacity override allows you to model specific weight/volume restrictions by transport mode or equipment that can be assigned to any itinerary leg to control whether a shipment can be planned for that leg. For example, some countries or regions have specific capacity restrictions such as bridges that have maximum weight limits. By creating a capacity override and assigning it to a specific itinerary leg, Oracle Transportation Management will override the equipment capacity. For example, if an equipment has a capacity of 30000 pounds, but the capacity override says 27000 pounds, then the system will not plan more than 27000 pounds in the equipment.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true

{
    "properties":{
        "capacityOverrideGid":{
            "description":"The GID for the capacity override details related to this itinerary leg. The capacity override allows you to model specific weight/volume restrictions by transport mode or equipment that can be assigned to any itinerary leg to control whether a shipment can be planned for that leg. For example, some countries or regions have specific capacity restrictions such as bridges that have maximum weight limits. By creating a capacity override and assigning it to a specific itinerary leg, Oracle Transportation Management will override the equipment capacity. For example, if an equipment has a capacity of 30000 pounds, but the capacity override says 27000 pounds, then the system will not plan more than 27000 pounds in the equipment.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "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 : links

Type: object

Show Source

• href: string
• rel: string

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

Back to Top