Jump to

• Request
• Response

Get Repetition Schedules

get

/repetitionSchedules

Request

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.
• limit: integer(int32)
  Positive integer value that specifies the maximum number of items returned by the server.
• offset: integer(int32)
  Non-negative integer values that specifies the index of the first item to be returned. The offset index begins at 0. By default, the offset is 0, which returns all items starting from the first item in the collection.
• orderBy: string
  Comma-separated string of field names, each optionally followed by asc or desc, that specifies the order of items returned in the response payload.
• q: string
  Filter (a 'where'clause) to restrict the items returned in the collection. By default, no filtering is applied.
• totalResults: boolean
  Boolean value that specifies whether to calculate the totalResults property. By default, this value is set to false indicating that totalResults is not calculated.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

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

Default Response

Default Response.

Body ()

Root Schema : schema

Type: object

Show Source

• items(required): array items
• links: array links

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/repetitionSchedules"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            }
        }
    },
    "required":[
        "items"
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object repetitionSchedules

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/repetitionSchedules"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    }
}

Nested Schema : repetitionSchedules

Type: object

Show Source

• calendarGid: string
  No description.
• cutoffTime: cutoffTime
  No description.
• details: details
• discontinueDate: discontinueDate
  No description.
• domainName: string
  No description.
• driverGid: string
  No description.
• driverProfileGid: string
  No description.
• effectiveDate: effectiveDate
  No description.
• equipmentGroupGid: string
  No description.
• flightGid: string
  No description.
• friday: boolean
  No description.
• insertDate: insertDate
  Read Only: true

  insert date
• isFixedEquipmentGroup: boolean
  No description.
• isIgnoreEquipmentCapacity: boolean
  No description.
• links: array links
  Read Only: true
• maxVolume: maxVolume
  No description.
• maxWeight: maxWeight
  No description.
• monday: boolean
  No description.
• numOfInstancesF: number (int32)
  No description.
• numOfInstancesM: number (int32)
  No description.
• numOfInstancesSa: number (int32)
  No description.
• numOfInstancesSu: number (int32)
  No description.
• numOfInstancesTh: number (int32)
  No description.
• numOfInstancesTu: number (int32)
  No description.
• numOfInstancesW: number (int32)
  No description.
• referenceNumber: string
  No description.
• refnums: refnums
• remarks: remarks
• repetitionScheduleGid: string
  No description.
• repetitionScheduleXid: string
  No description.
• repSchedServiceGid: string
  No description.
• saturday: boolean
  No description.
• scheduleNote: string
  No description.
• scheduleType: string
  No description.
• servprovGid: string
  No description.
• servprovProfileGid: string
  No description.
• startTimeAdj: startTimeAdj
  No description.
• stops: stops
• sunday: boolean
  No description.
• thursday: boolean
  No description.
• tuesday: boolean
  No description.
• updateDate: updateDate
  Read Only: true

  update date
• voyageGid: string
  No description.
• wednesday: boolean
  No description.

{
    "properties":{
        "repetitionScheduleGid":{
            "description":"No description.",
            "type":"string"
        },
        "repetitionScheduleXid":{
            "description":"No description.",
            "type":"string"
        },
        "servprovGid":{
            "description":"No description.",
            "type":"string"
        },
        "monday":{
            "description":"No description.",
            "type":"boolean"
        },
        "tuesday":{
            "description":"No description.",
            "type":"boolean"
        },
        "wednesday":{
            "description":"No description.",
            "type":"boolean"
        },
        "thursday":{
            "description":"No description.",
            "type":"boolean"
        },
        "friday":{
            "description":"No description.",
            "type":"boolean"
        },
        "saturday":{
            "description":"No description.",
            "type":"boolean"
        },
        "sunday":{
            "description":"No description.",
            "type":"boolean"
        },
        "repSchedServiceGid":{
            "description":"No description.",
            "type":"string"
        },
        "effectiveDate":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "discontinueDate":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "scheduleNote":{
            "description":"No description.",
            "type":"string"
        },
        "referenceNumber":{
            "description":"No description.",
            "type":"string"
        },
        "scheduleType":{
            "description":"No description.",
            "type":"string"
        },
        "flightGid":{
            "description":"No description.",
            "type":"string"
        },
        "voyageGid":{
            "description":"No description.",
            "type":"string"
        },
        "equipmentGroupGid":{
            "description":"No description.",
            "type":"string"
        },
        "isIgnoreEquipmentCapacity":{
            "description":"No description.",
            "type":"boolean"
        },
        "maxWeight":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "maxVolume":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "startTimeAdj":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "cutoffTime":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "calendarGid":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "driverGid":{
            "description":"No description.",
            "type":"string"
        },
        "driverProfileGid":{
            "description":"No description.",
            "type":"string"
        },
        "numOfInstancesM":{
            "description":"No description.",
            "type":"number",
            "format":"int32"
        },
        "numOfInstancesTu":{
            "description":"No description.",
            "type":"number",
            "format":"int32"
        },
        "numOfInstancesW":{
            "description":"No description.",
            "type":"number",
            "format":"int32"
        },
        "numOfInstancesTh":{
            "description":"No description.",
            "type":"number",
            "format":"int32"
        },
        "numOfInstancesF":{
            "description":"No description.",
            "type":"number",
            "format":"int32"
        },
        "numOfInstancesSa":{
            "description":"No description.",
            "type":"number",
            "format":"int32"
        },
        "numOfInstancesSu":{
            "description":"No description.",
            "type":"number",
            "format":"int32"
        },
        "isFixedEquipmentGroup":{
            "description":"No description.",
            "type":"boolean"
        },
        "servprovProfileGid":{
            "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
        },
        "stops":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/repetitionSchedules.stops"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "refnums":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/repetitionSchedules.refnums"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "details":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/repetitionSchedules.details"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/repetitionSchedules.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : cutoffTime

No description.

Match All

Show Source

• object dateTimeType

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

Nested Schema : details

Type: object

Show Source

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

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

Nested Schema : discontinueDate

No description.

Match All

Show Source

• object dateTimeType

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

Nested Schema : effectiveDate

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

No description.

Match All

Show Source

• object amountType

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

Nested Schema : maxWeight

No description.

Match All

Show Source

• object amountType

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

Nested Schema : refnums

Type: object

Show Source

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

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

Nested Schema : remarks

Type: object

Show Source

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

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

Nested Schema : startTimeAdj

No description.

Match All

Show Source

• object amountType

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

Nested Schema : stops

Type: object

Show Source

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

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

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

Type: array

Show Source

• Array of: object repetitionSchedules.details

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/repetitionSchedules.details"
    }
}

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 : repetitionSchedules.details

Type: object

Show Source

• domainName: string
  No description.
• groundSchedGenGid: string
  No description.
• links: array links
  Read Only: true
• shipmentGid: string
  No description.

{
    "properties":{
        "groundSchedGenGid":{
            "description":"No description.",
            "type":"string"
        },
        "shipmentGid":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "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 : 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"
        }
    }
}

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 repetitionSchedules.refnums

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/repetitionSchedules.refnums"
    }
}

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 : repetitionSchedules.refnums

Type: object

Show Source

• domainName: string
  No description.
• groundRefnumQualGid: string
  No description.
• groundRefnumValue: string
  No description.
• links: array links
  Read Only: true

{
    "properties":{
        "groundRefnumQualGid":{
            "description":"No description.",
            "type":"string"
        },
        "groundRefnumValue":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "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 repetitionSchedules.remarks

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/repetitionSchedules.remarks"
    }
}

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 : repetitionSchedules.remarks

Type: object

Show Source

• domainName: string
  No description.
• links: array links
  Read Only: true
• remarkQualGid: string
  No description.
• remarkSequence: number (int64)
  No description.
• remarkText: string
  No description.

{
    "properties":{
        "remarkSequence":{
            "description":"No description.",
            "type":"number",
            "format":"int64"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "remarkQualGid":{
            "description":"No description.",
            "type":"string"
        },
        "remarkText":{
            "description":"No description.",
            "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 repetitionSchedules.stops

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/repetitionSchedules.stops"
    }
}

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 : repetitionSchedules.stops

Type: object

Show Source

• details: details
• domainName: string
  No description.
• dtimeFromPrevStop: dtimeFromPrevStop
  No description.
• isAllowDelivery: boolean
  No description.
• isAllowPickup: boolean
  No description.
• isFixedArrival: boolean
  No description.
• isFixedDeparture: boolean
  No description.
• links: array links
  Read Only: true
• locationGid: string
  No description.
• maxDeliveryVolume: maxDeliveryVolume
  No description.
• maxDeliveryWeight: maxDeliveryWeight
  No description.
• maxPickupVolume: maxPickupVolume
  No description.
• maxPickupWeight: maxPickupWeight
  No description.
• sequence: number (int32)
  No description.
• stopNumber: number (int32)
  No description.
• stopRequirementType: string
  No description.

{
    "properties":{
        "sequence":{
            "description":"No description.",
            "type":"number",
            "format":"int32"
        },
        "locationGid":{
            "description":"No description.",
            "type":"string"
        },
        "stopNumber":{
            "description":"No description.",
            "type":"number",
            "format":"int32"
        },
        "stopRequirementType":{
            "description":"No description.",
            "type":"string"
        },
        "isAllowPickup":{
            "description":"No description.",
            "type":"boolean"
        },
        "isAllowDelivery":{
            "description":"No description.",
            "type":"boolean"
        },
        "maxPickupWeight":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "maxPickupVolume":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "maxDeliveryWeight":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "maxDeliveryVolume":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "dtimeFromPrevStop":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "isFixedArrival":{
            "description":"No description.",
            "type":"boolean"
        },
        "isFixedDeparture":{
            "description":"No description.",
            "type":"boolean"
        },
        "details":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/repetitionSchedules.stops.details"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : details

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/repetitionSchedules.stops.details"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : dtimeFromPrevStop

No description.

Match All

Show Source

• object amountType

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

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

No description.

Match All

Show Source

• object amountType

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

Nested Schema : maxDeliveryWeight

No description.

Match All

Show Source

• object amountType

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

Nested Schema : maxPickupVolume

No description.

Match All

Show Source

• object amountType

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

Nested Schema : maxPickupWeight

No description.

Match All

Show Source

• object amountType

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

Nested Schema : items

Type: array

Show Source

• Array of: object repetitionSchedules.stops.details

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/repetitionSchedules.stops.details"
    }
}

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 : repetitionSchedules.stops.details

Type: object

Show Source

• dayAdjustment: number (int32)
  No description.
• domainName: string
  No description.
• hourAdjustment: number (int32)
  No description.
• links: array links
  Read Only: true
• minuteAdjustment: number (int32)
  No description.
• repSchedActivityGid: string
  No description.

{
    "properties":{
        "repSchedActivityGid":{
            "description":"No description.",
            "type":"string"
        },
        "dayAdjustment":{
            "description":"No description.",
            "type":"number",
            "format":"int32"
        },
        "hourAdjustment":{
            "description":"No description.",
            "type":"number",
            "format":"int32"
        },
        "minuteAdjustment":{
            "description":"No description.",
            "type":"number",
            "format":"int32"
        },
        "domainName":{
            "description":"No description.",
            "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