Jump to

• Request
• Response

Get Power Units

get

/drivers/{driverGid}/powerUnits

Request

Path Parameters

• driverGid(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.
• 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/drivers.powerUnits"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            }
        }
    },
    "required":[
        "items"
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object drivers.powerUnits

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/drivers.powerUnits"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object links

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

Nested Schema : drivers.powerUnits

Type: object

Show Source

• calendarGid: string
  The GID for the calendar that determines the day and times when the power unit can be used with the driver. For example, if you select a calendar for Monday through Friday, 8 a.m.-8 p.m., that power unit would be used with that driver Monday through Friday, 8 a.m.-8 p.m.. On a different driver you could then select a time of Monday through Friday, 8 p.m. -8 a.m., as well as on any time on Saturday and Sunday, and assign the same power unit to a different driver. Only calendars with an activity of Driver Work will be considered for overlap when other drivers share the same power unit. Validation checks against other calendars for duplicate assignments when you save. By establishing power unit availability to multiple drivers through the use of a calendar, you are defining "slip seating".
• domainName: string
  Database domain where this data is stored.
• effectiveDate: effectiveDate
  The effective date for this Driver and Power Unit union.
• expirationDate: expirationDate
  The expiration date for this Driver and Power Unit union.
• links: array links
  Read Only: true
• powerUnitGid: string
  The power unit assigned to the driver.
• sequence: number (int64)
  Primary key of the table.

{
    "properties":{
        "sequence":{
            "description":"Primary key of the table.",
            "type":"number",
            "format":"int64"
        },
        "powerUnitGid":{
            "description":"The power unit assigned to the driver.",
            "type":"string"
        },
        "effectiveDate":{
            "description":"The effective date for this Driver and Power Unit union.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "expirationDate":{
            "description":"The expiration date for this Driver and Power Unit union.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "calendarGid":{
            "description":"The GID for the calendar that determines the day and times when the power unit can be used with the driver. For example, if you select a calendar for Monday through Friday, 8 a.m.-8 p.m., that power unit would be used with that driver Monday through Friday, 8 a.m.-8 p.m.. On a different driver you could then select a time of Monday through Friday, 8 p.m. -8 a.m., as well as on any time on Saturday and Sunday, and assign the same power unit to a different driver. Only calendars with an activity of Driver Work will be considered for overlap when other drivers share the same power unit. Validation checks against other calendars for duplicate assignments when you save. By establishing power unit availability to multiple drivers through the use of a calendar, you are defining \"slip seating\".",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : effectiveDate

The effective date for this Driver and Power Unit union.

Match All

Show Source

• object dateTimeType

{
    "description":"The effective date for this Driver and Power Unit union.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : expirationDate

The expiration date for this Driver and Power Unit union.

Match All

Show Source

• object dateTimeType

{
    "description":"The expiration date for this Driver and Power Unit union.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

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

Type: object

Show Source

• href: string
• rel: string

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

Back to Top