Jump to

• Request
• Response

Create a Hours of Service Rule

post

/trackingEvents/{iTransactionNo}/hosRules

Request

Path Parameters

• iTransactionNo(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/trackingEvents.hosRules"
            }
        }
    },
    "required":[
        "items"
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/trackingEvents.hosRules"
    }
}

Nested Schema : schema

Type: object

Show Source

• activityTime: activityTime
  The activity time associated with the hours of service reported for the tracking event.
• activityTimeRemain: activityTimeRemain
  The activity time remaining against that hours of service.
• domainName: string
  Database domain where this data is stored.
• hosRuleGid: string
  The hours of service rule GID for the given tracking event.
• iRecNo: number (int64)
  The record number primary key identifier for the tracking event specified.
• links: array links
  Read Only: true
• ruleBeginTime: ruleBeginTime
  The begin time defined for the hours of service rule.

{
    "properties":{
        "iRecNo":{
            "description":"The record number primary key identifier for the tracking event specified.",
            "type":"number",
            "format":"int64"
        },
        "hosRuleGid":{
            "description":"The hours of service rule GID for the given tracking event.",
            "type":"string"
        },
        "activityTime":{
            "description":"The activity time associated with the hours of service reported for the tracking event.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "ruleBeginTime":{
            "description":"The begin time defined for the hours of service rule.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "activityTimeRemain":{
            "description":"The activity time remaining against that hours of service.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : activityTime

The activity time associated with the hours of service reported for the tracking event.

Match All

Show Source

• object amountType

{
    "description":"The activity time associated with the hours of service reported for the tracking event.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : activityTimeRemain

The activity time remaining against that hours of service.

Match All

Show Source

• object amountType

{
    "description":"The activity time remaining against that hours of service.",
    "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 : ruleBeginTime

The begin time defined for the hours of service rule.

Match All

Show Source

• object dateTimeType

{
    "description":"The begin time defined for the hours of service rule.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

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

Type: object

Show Source

• href: string
• rel: string

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

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

Request Body - application/vnd.oracle.resource+json;type=singular ()

Root Schema : schema

Type: object

Show Source

• activityTime: activityTime
  The activity time associated with the hours of service reported for the tracking event.
• activityTimeRemain: activityTimeRemain
  The activity time remaining against that hours of service.
• domainName: string
  Database domain where this data is stored.
• hosRuleGid: string
  The hours of service rule GID for the given tracking event.
• iRecNo: number (int64)
  The record number primary key identifier for the tracking event specified.
• links: array links
  Read Only: true
• ruleBeginTime: ruleBeginTime
  The begin time defined for the hours of service rule.

{
    "properties":{
        "iRecNo":{
            "description":"The record number primary key identifier for the tracking event specified.",
            "type":"number",
            "format":"int64"
        },
        "hosRuleGid":{
            "description":"The hours of service rule GID for the given tracking event.",
            "type":"string"
        },
        "activityTime":{
            "description":"The activity time associated with the hours of service reported for the tracking event.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "ruleBeginTime":{
            "description":"The begin time defined for the hours of service rule.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "activityTimeRemain":{
            "description":"The activity time remaining against that hours of service.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : activityTime

The activity time associated with the hours of service reported for the tracking event.

Match All

Show Source

• object amountType

{
    "description":"The activity time associated with the hours of service reported for the tracking event.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : activityTimeRemain

The activity time remaining against that hours of service.

Match All

Show Source

• object amountType

{
    "description":"The activity time remaining against that hours of service.",
    "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 : ruleBeginTime

The begin time defined for the hours of service rule.

Match All

Show Source

• object dateTimeType

{
    "description":"The begin time defined for the hours of service rule.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

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

Type: object

Show Source

• href: string
• rel: string

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

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

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

• activityTime: activityTime
  The activity time associated with the hours of service reported for the tracking event.
• activityTimeRemain: activityTimeRemain
  The activity time remaining against that hours of service.
• domainName: string
  Database domain where this data is stored.
• hosRuleGid: string
  The hours of service rule GID for the given tracking event.
• iRecNo: number (int64)
  The record number primary key identifier for the tracking event specified.
• links: array links
  Read Only: true
• ruleBeginTime: ruleBeginTime
  The begin time defined for the hours of service rule.

{
    "properties":{
        "iRecNo":{
            "description":"The record number primary key identifier for the tracking event specified.",
            "type":"number",
            "format":"int64"
        },
        "hosRuleGid":{
            "description":"The hours of service rule GID for the given tracking event.",
            "type":"string"
        },
        "activityTime":{
            "description":"The activity time associated with the hours of service reported for the tracking event.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "ruleBeginTime":{
            "description":"The begin time defined for the hours of service rule.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "activityTimeRemain":{
            "description":"The activity time remaining against that hours of service.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : activityTime

The activity time associated with the hours of service reported for the tracking event.

Match All

Show Source

• object amountType

{
    "description":"The activity time associated with the hours of service reported for the tracking event.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : activityTimeRemain

The activity time remaining against that hours of service.

Match All

Show Source

• object amountType

{
    "description":"The activity time remaining against that hours of service.",
    "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 : ruleBeginTime

The begin time defined for the hours of service rule.

Match All

Show Source

• object dateTimeType

{
    "description":"The begin time defined for the hours of service rule.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

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

Type: object

Show Source

• href: string
• rel: string

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

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

Back to Top