Jump to

• Request
• Response

Create a Leg Constraint

post

/orderBases/{orderBaseGid}/legConstraints

Request

Path Parameters

• orderBaseGid(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/orderBases.legConstraints"
            }
        }
    },
    "required":[
        "items"
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderBases.legConstraints"
    }
}

Nested Schema : schema

Type: object

Show Source

• buyRateGeoGid: string
  The buy rate detail GID used as a planning constraint.
• buyRateOfferingGid: string
  The buy rate offering GID used as a planning constraint.
• domainName: string
  Database domain where this data is stored.
• equipmentGroupGid: string
  The equipment group GID used as a planning constraint.
• equipmentGroupProfileGid: string
  The equipment group profile GID used as a planning constraint.
• legClassificationGid: string
  The leg classification identifier. The leg classification on the order matches to a leg classification on the itinerary leg. The constraints defined here apply to that leg's shipment.
• links: array links
  Read Only: true
• modeProfileGid: string
  The rate service profile GID used as a planning constraint.
• rateServiceProfileGid: string
  The service provider profile GID used as a planning constraint.
• sellRateGeoGid: string
  The sell rate detail GID used as a planning constraint.
• sellRateOfferingGid: string
  The sell rate offering GID used as a planning constraint.
• servprovGid: string
  The mode profile GID used as a planning constraint.
• servprovProfileGid: string
  The service provider GID used as a planning constraint.
• transportModeGid: string
  The transport mode GID used as a planning constraint.

{
    "properties":{
        "legClassificationGid":{
            "description":"The leg classification identifier. The leg classification on the order matches to a leg classification on the itinerary leg. The constraints defined here apply to that leg's shipment.",
            "type":"string"
        },
        "buyRateOfferingGid":{
            "description":"The buy rate offering GID used as a planning constraint.",
            "type":"string"
        },
        "sellRateOfferingGid":{
            "description":"The sell rate offering GID used as a planning constraint.",
            "type":"string"
        },
        "buyRateGeoGid":{
            "description":"The buy rate detail GID used as a planning constraint.",
            "type":"string"
        },
        "sellRateGeoGid":{
            "description":"The sell rate detail GID used as a planning constraint.",
            "type":"string"
        },
        "equipmentGroupGid":{
            "description":"The equipment group GID used as a planning constraint.",
            "type":"string"
        },
        "equipmentGroupProfileGid":{
            "description":"The equipment group profile GID used as a planning constraint.",
            "type":"string"
        },
        "transportModeGid":{
            "description":"The transport mode GID used as a planning constraint.",
            "type":"string"
        },
        "servprovGid":{
            "description":"The mode profile GID used as a planning constraint.",
            "type":"string"
        },
        "servprovProfileGid":{
            "description":"The service provider GID used as a planning constraint.",
            "type":"string"
        },
        "rateServiceProfileGid":{
            "description":"The service provider profile GID used as a planning constraint.",
            "type":"string"
        },
        "modeProfileGid":{
            "description":"The rate service profile GID used as a planning constraint.",
            "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

• buyRateGeoGid: string
  The buy rate detail GID used as a planning constraint.
• buyRateOfferingGid: string
  The buy rate offering GID used as a planning constraint.
• domainName: string
  Database domain where this data is stored.
• equipmentGroupGid: string
  The equipment group GID used as a planning constraint.
• equipmentGroupProfileGid: string
  The equipment group profile GID used as a planning constraint.
• legClassificationGid: string
  The leg classification identifier. The leg classification on the order matches to a leg classification on the itinerary leg. The constraints defined here apply to that leg's shipment.
• links: array links
  Read Only: true
• modeProfileGid: string
  The rate service profile GID used as a planning constraint.
• rateServiceProfileGid: string
  The service provider profile GID used as a planning constraint.
• sellRateGeoGid: string
  The sell rate detail GID used as a planning constraint.
• sellRateOfferingGid: string
  The sell rate offering GID used as a planning constraint.
• servprovGid: string
  The mode profile GID used as a planning constraint.
• servprovProfileGid: string
  The service provider GID used as a planning constraint.
• transportModeGid: string
  The transport mode GID used as a planning constraint.

{
    "properties":{
        "legClassificationGid":{
            "description":"The leg classification identifier. The leg classification on the order matches to a leg classification on the itinerary leg. The constraints defined here apply to that leg's shipment.",
            "type":"string"
        },
        "buyRateOfferingGid":{
            "description":"The buy rate offering GID used as a planning constraint.",
            "type":"string"
        },
        "sellRateOfferingGid":{
            "description":"The sell rate offering GID used as a planning constraint.",
            "type":"string"
        },
        "buyRateGeoGid":{
            "description":"The buy rate detail GID used as a planning constraint.",
            "type":"string"
        },
        "sellRateGeoGid":{
            "description":"The sell rate detail GID used as a planning constraint.",
            "type":"string"
        },
        "equipmentGroupGid":{
            "description":"The equipment group GID used as a planning constraint.",
            "type":"string"
        },
        "equipmentGroupProfileGid":{
            "description":"The equipment group profile GID used as a planning constraint.",
            "type":"string"
        },
        "transportModeGid":{
            "description":"The transport mode GID used as a planning constraint.",
            "type":"string"
        },
        "servprovGid":{
            "description":"The mode profile GID used as a planning constraint.",
            "type":"string"
        },
        "servprovProfileGid":{
            "description":"The service provider GID used as a planning constraint.",
            "type":"string"
        },
        "rateServiceProfileGid":{
            "description":"The service provider profile GID used as a planning constraint.",
            "type":"string"
        },
        "modeProfileGid":{
            "description":"The rate service profile GID used as a planning constraint.",
            "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

• buyRateGeoGid: string
  The buy rate detail GID used as a planning constraint.
• buyRateOfferingGid: string
  The buy rate offering GID used as a planning constraint.
• domainName: string
  Database domain where this data is stored.
• equipmentGroupGid: string
  The equipment group GID used as a planning constraint.
• equipmentGroupProfileGid: string
  The equipment group profile GID used as a planning constraint.
• legClassificationGid: string
  The leg classification identifier. The leg classification on the order matches to a leg classification on the itinerary leg. The constraints defined here apply to that leg's shipment.
• links: array links
  Read Only: true
• modeProfileGid: string
  The rate service profile GID used as a planning constraint.
• rateServiceProfileGid: string
  The service provider profile GID used as a planning constraint.
• sellRateGeoGid: string
  The sell rate detail GID used as a planning constraint.
• sellRateOfferingGid: string
  The sell rate offering GID used as a planning constraint.
• servprovGid: string
  The mode profile GID used as a planning constraint.
• servprovProfileGid: string
  The service provider GID used as a planning constraint.
• transportModeGid: string
  The transport mode GID used as a planning constraint.

{
    "properties":{
        "legClassificationGid":{
            "description":"The leg classification identifier. The leg classification on the order matches to a leg classification on the itinerary leg. The constraints defined here apply to that leg's shipment.",
            "type":"string"
        },
        "buyRateOfferingGid":{
            "description":"The buy rate offering GID used as a planning constraint.",
            "type":"string"
        },
        "sellRateOfferingGid":{
            "description":"The sell rate offering GID used as a planning constraint.",
            "type":"string"
        },
        "buyRateGeoGid":{
            "description":"The buy rate detail GID used as a planning constraint.",
            "type":"string"
        },
        "sellRateGeoGid":{
            "description":"The sell rate detail GID used as a planning constraint.",
            "type":"string"
        },
        "equipmentGroupGid":{
            "description":"The equipment group GID used as a planning constraint.",
            "type":"string"
        },
        "equipmentGroupProfileGid":{
            "description":"The equipment group profile GID used as a planning constraint.",
            "type":"string"
        },
        "transportModeGid":{
            "description":"The transport mode GID used as a planning constraint.",
            "type":"string"
        },
        "servprovGid":{
            "description":"The mode profile GID used as a planning constraint.",
            "type":"string"
        },
        "servprovProfileGid":{
            "description":"The service provider GID used as a planning constraint.",
            "type":"string"
        },
        "rateServiceProfileGid":{
            "description":"The service provider profile GID used as a planning constraint.",
            "type":"string"
        },
        "modeProfileGid":{
            "description":"The rate service profile GID used as a planning constraint.",
            "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