Create a Leg
post
/itineraries/{itineraryGid}/legs
Request
Path Parameters
-
itineraryGid(required): string
Resource ID
Supported Media Types
- application/vnd.oracle.resource+json;type=singular
- application/vnd.oracle.resource+json;type=collection
Nested Schema : schema
Type:
Show Source
object
-
capacityOverrides:
capacityOverrides
-
domainName: string
Database domain where this data is stored.
-
flexCommodityProfilelists:
flexCommodityProfilelists
-
interimPoints:
interimPoints
-
involvedParties:
involvedParties
-
legGid: string
Contains the GID for a leg on the itinerary.
-
links: array
links
Read Only:
true
-
schedules:
schedules
-
sequenceNo: number
(int32)
Sequence number for the itinerary leg.
Nested Schema : capacityOverrides
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : flexCommodityProfilelists
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : interimPoints
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : involvedParties
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : schedules
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : itineraries.legs.capacityOverrides
Type:
Show Source
object
-
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
Nested Schema : itineraries.legs.flexCommodityProfilelists
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
flexCommodityProfileGid: string
Contains the GID for the flex commodity profile for the leg.
-
links: array
links
Read Only:
true
Nested Schema : itineraries.legs.interimPoints
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
locationGid: string
Contains the GID for the location for the leg.
-
seqNo: number
(int32)
Contains the sequence number for the leg.
-
specialServiceGid: string
The special service needed for this interim point. It will be added to the corresponding shipment stop special service.
Nested Schema : itineraries.legs.involvedParties
Type:
Show Source
object
-
comMethodGid: string
The GID for the communication method.
-
domainName: string
Database domain where this data is stored.
-
involvedPartyContactGid: string
The GID for the involved party contact.
-
involvedPartyQualGid: string
The GID for the involved party qualifier related to the itinerary leg.
-
links: array
links
Read Only:
true
Nested Schema : itineraries.legs.schedules
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
repetitionScheduleGid: string
The GID for the repetition schedule (ground schedule) being assigned to the itinerary leg.
Root Schema : schema
Type:
Show Source
object
-
capacityOverrides:
capacityOverrides
-
domainName: string
Database domain where this data is stored.
-
flexCommodityProfilelists:
flexCommodityProfilelists
-
interimPoints:
interimPoints
-
involvedParties:
involvedParties
-
legGid: string
Contains the GID for a leg on the itinerary.
-
links: array
links
Read Only:
true
-
schedules:
schedules
-
sequenceNo: number
(int32)
Sequence number for the itinerary leg.
Nested Schema : capacityOverrides
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : flexCommodityProfilelists
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : interimPoints
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : involvedParties
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : schedules
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : itineraries.legs.capacityOverrides
Type:
Show Source
object
-
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
Nested Schema : itineraries.legs.flexCommodityProfilelists
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
flexCommodityProfileGid: string
Contains the GID for the flex commodity profile for the leg.
-
links: array
links
Read Only:
true
Nested Schema : itineraries.legs.interimPoints
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
locationGid: string
Contains the GID for the location for the leg.
-
seqNo: number
(int32)
Contains the sequence number for the leg.
-
specialServiceGid: string
The special service needed for this interim point. It will be added to the corresponding shipment stop special service.
Nested Schema : itineraries.legs.involvedParties
Type:
Show Source
object
-
comMethodGid: string
The GID for the communication method.
-
domainName: string
Database domain where this data is stored.
-
involvedPartyContactGid: string
The GID for the involved party contact.
-
involvedPartyQualGid: string
The GID for the involved party qualifier related to the itinerary leg.
-
links: array
links
Read Only:
true
Nested Schema : itineraries.legs.schedules
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
repetitionScheduleGid: string
The GID for the repetition schedule (ground schedule) being assigned to the itinerary leg.
Response
Supported Media Types
- application/vnd.oracle.resource+json;type=singular
- application/vnd.oracle.resource+json;type=collection
Default Response
Default Response.
Root Schema : schema
Type:
Show Source
object
-
capacityOverrides:
capacityOverrides
-
domainName: string
Database domain where this data is stored.
-
flexCommodityProfilelists:
flexCommodityProfilelists
-
interimPoints:
interimPoints
-
involvedParties:
involvedParties
-
legGid: string
Contains the GID for a leg on the itinerary.
-
links: array
links
Read Only:
true
-
schedules:
schedules
-
sequenceNo: number
(int32)
Sequence number for the itinerary leg.
Nested Schema : capacityOverrides
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : flexCommodityProfilelists
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : interimPoints
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : involvedParties
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : schedules
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : itineraries.legs.capacityOverrides
Type:
Show Source
object
-
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
Nested Schema : itineraries.legs.flexCommodityProfilelists
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
flexCommodityProfileGid: string
Contains the GID for the flex commodity profile for the leg.
-
links: array
links
Read Only:
true
Nested Schema : itineraries.legs.interimPoints
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
locationGid: string
Contains the GID for the location for the leg.
-
seqNo: number
(int32)
Contains the sequence number for the leg.
-
specialServiceGid: string
The special service needed for this interim point. It will be added to the corresponding shipment stop special service.
Nested Schema : itineraries.legs.involvedParties
Type:
Show Source
object
-
comMethodGid: string
The GID for the communication method.
-
domainName: string
Database domain where this data is stored.
-
involvedPartyContactGid: string
The GID for the involved party contact.
-
involvedPartyQualGid: string
The GID for the involved party qualifier related to the itinerary leg.
-
links: array
links
Read Only:
true
Nested Schema : itineraries.legs.schedules
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
repetitionScheduleGid: string
The GID for the repetition schedule (ground schedule) being assigned to the itinerary leg.