Jump to

• Request
• Response

Get a Leg

get

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

Request

Path Parameters

• itineraryGid(required): string
  Resource ID
• legGid(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 : schema

Type: object

Show Source

• 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.

{
    "properties":{
        "legGid":{
            "description":"Contains the GID for a leg on the itinerary.",
            "type":"string"
        },
        "sequenceNo":{
            "description":"Sequence number for the itinerary leg.",
            "type":"number",
            "format":"int32"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "interimPoints":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itineraries.legs.interimPoints"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "flexCommodityProfilelists":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itineraries.legs.flexCommodityProfilelists"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "involvedParties":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itineraries.legs.involvedParties"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "schedules":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itineraries.legs.schedules"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "capacityOverrides":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itineraries.legs.capacityOverrides"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : capacityOverrides

Type: object

Show Source

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

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

Nested Schema : flexCommodityProfilelists

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/itineraries.legs.flexCommodityProfilelists"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : interimPoints

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/itineraries.legs.interimPoints"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : involvedParties

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/itineraries.legs.involvedParties"
            }
        },
        "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 : schedules

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/itineraries.legs.schedules"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object itineraries.legs.capacityOverrides

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

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 : itineraries.legs.capacityOverrides

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

Nested Schema : items

Type: array

Show Source

• Array of: object itineraries.legs.flexCommodityProfilelists

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

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 : itineraries.legs.flexCommodityProfilelists

Type: object

Show Source

• 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

{
    "properties":{
        "flexCommodityProfileGid":{
            "description":"Contains the GID for the flex commodity profile for the leg.",
            "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 : items

Type: array

Show Source

• Array of: object itineraries.legs.interimPoints

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

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 : itineraries.legs.interimPoints

Type: object

Show Source

• 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.

{
    "properties":{
        "seqNo":{
            "description":"Contains the sequence number for the leg.",
            "type":"number",
            "format":"int32"
        },
        "locationGid":{
            "description":"Contains the GID for the location for the leg.",
            "type":"string"
        },
        "specialServiceGid":{
            "description":"The special service needed for this interim point. It will be added to the corresponding shipment stop special service.",
            "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 : items

Type: array

Show Source

• Array of: object itineraries.legs.involvedParties

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

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 : itineraries.legs.involvedParties

Type: object

Show Source

• 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

{
    "properties":{
        "involvedPartyQualGid":{
            "description":"The GID for the involved party qualifier related to the itinerary leg.",
            "type":"string"
        },
        "involvedPartyContactGid":{
            "description":"The GID for the involved party contact.",
            "type":"string"
        },
        "comMethodGid":{
            "description":"The GID for the communication method.",
            "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 : items

Type: array

Show Source

• Array of: object itineraries.legs.schedules

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

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 : itineraries.legs.schedules

Type: object

Show Source

• 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.

{
    "properties":{
        "repetitionScheduleGid":{
            "description":"The GID for the repetition schedule (ground schedule) being assigned to the itinerary leg.",
            "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
}

Back to Top