Jump to

• Request
• Response

Create a schedule shift detail

post

/hcmRestApi/resources/11.13.18.05/scheduleRequests/{schedRequestId}/child/scheduleEvents/{schedEventId}/child/scheduleShiftEvents/{schedShiftEventId}/child/scheduleShiftDetailEvents

Request

Path Parameters

• schedEventId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• schedRequestId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• schedShiftEventId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• endTime: string (date-time)
  End time of the shift detail, entered with the time zone offset.
• endTimeOffset: integer (int64)
  Time zone offset for the shift detail end time.
• schedEventNumber: string
  Maximum Length: 120

  Unique identifier of the schedule event.
• schedRequestNumber: string
  Maximum Length: 120

  Unique identifier of the schedule request.
• schedShiftDetailEventId: integer (int64)
  Surrogate ID for the schedule shift detail event, available only to reference existing records.
• schedShiftEventId: integer (int64)
  Unique identifier to reference the schedule shift event containing the shift detail.
• schedShiftEventNumber: string
  Maximum Length: 120

  Unique identifier of the schedule shift event.
• shiftDetailAction: string
  Maximum Length: 10

  Action to perform on the shift detail, such as CREATE, UPDATE, or DELETE.
• shiftDetailEndTime: string
  Maximum Length: 80

  End time of the shift detail as a string value.
• shiftDetailEventNumber: string
  Maximum Length: 120

  Unique identifier of the shift detail event in the source system.
• shiftDetailNumber: string
  Maximum Length: 30

  Unique identifier of the shift detail in the source system. It's mandatory only when you update or delete shift details.
• shiftDetailStartTime: string
  Maximum Length: 80

  Start time of the shift detail as a string value.
• shiftDetailType: string
  Maximum Length: 30

  Type of shift detail, such as ORA_HTS_PAID_BREAK.
• startTime: string (date-time)
  Start time of the shift detail, entered with the time zone offset.
• startTimeOffset: integer (int64)
  Time zone offset for the shift detail start time.

{
    "type":"object",
    "properties":{
        "endTime":{
            "type":"string",
            "description":"End time of the shift detail, entered with the time zone offset.",
            "format":"date-time",
            "nullable":true
        },
        "endTimeOffset":{
            "type":"integer",
            "description":"Time zone offset for the shift detail end time.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":22
            }
        },
        "schedEventNumber":{
            "maxLength":120,
            "type":"string",
            "description":"Unique identifier of the schedule event.",
            "nullable":true
        },
        "schedRequestNumber":{
            "maxLength":120,
            "type":"string",
            "description":"Unique identifier of the schedule request.",
            "nullable":true
        },
        "schedShiftDetailEventId":{
            "type":"integer",
            "description":"Surrogate ID for the schedule shift detail event, available only to reference existing records.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "schedShiftEventId":{
            "type":"integer",
            "description":"Unique identifier to reference the schedule shift event containing the shift detail.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "schedShiftEventNumber":{
            "maxLength":120,
            "type":"string",
            "description":"Unique identifier of the schedule shift event.",
            "nullable":true
        },
        "shiftDetailAction":{
            "maxLength":10,
            "type":"string",
            "description":"Action to perform on the shift detail, such as CREATE, UPDATE, or DELETE.",
            "nullable":true
        },
        "shiftDetailEndTime":{
            "maxLength":80,
            "type":"string",
            "description":"End time of the shift detail as a string value.",
            "nullable":true
        },
        "shiftDetailEventNumber":{
            "maxLength":120,
            "type":"string",
            "description":"Unique identifier of the shift detail event in the source system.",
            "nullable":true
        },
        "shiftDetailNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Unique identifier of the shift detail in the source system. It's mandatory only when you update or delete shift details.",
            "nullable":true
        },
        "shiftDetailStartTime":{
            "maxLength":80,
            "type":"string",
            "description":"Start time of the shift detail as a string value.",
            "nullable":true
        },
        "shiftDetailType":{
            "maxLength":30,
            "type":"string",
            "description":"Type of shift detail, such as ORA_HTS_PAID_BREAK.",
            "nullable":true
        },
        "startTime":{
            "type":"string",
            "description":"Start time of the shift detail, entered with the time zone offset.",
            "format":"date-time",
            "nullable":true
        },
        "startTimeOffset":{
            "type":"integer",
            "description":"Time zone offset for the shift detail start time.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":22
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : scheduleRequests-scheduleEvents-scheduleShiftEvents-scheduleShiftDetailEvents-item-response

Type: object

Show Source

• endTime: string (date-time)
  End time of the shift detail, entered with the time zone offset.
• endTimeOffset: integer (int64)
  Time zone offset for the shift detail end time.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• schedEventNumber: string
  Maximum Length: 120

  Unique identifier of the schedule event.
• schedRequestNumber: string
  Maximum Length: 120

  Unique identifier of the schedule request.
• schedShiftDetailEventId: integer (int64)
  Surrogate ID for the schedule shift detail event, available only to reference existing records.
• schedShiftEventId: integer (int64)
  Unique identifier to reference the schedule shift event containing the shift detail.
• schedShiftEventNumber: string
  Maximum Length: 120

  Unique identifier of the schedule shift event.
• shiftDetailAction: string
  Maximum Length: 10

  Action to perform on the shift detail, such as CREATE, UPDATE, or DELETE.
• shiftDetailEndTime: string
  Maximum Length: 80

  End time of the shift detail as a string value.
• shiftDetailEventNumber: string
  Maximum Length: 120

  Unique identifier of the shift detail event in the source system.
• shiftDetailNumber: string
  Maximum Length: 30

  Unique identifier of the shift detail in the source system. It's mandatory only when you update or delete shift details.
• shiftDetailStartTime: string
  Maximum Length: 80

  Start time of the shift detail as a string value.
• shiftDetailType: string
  Maximum Length: 30

  Type of shift detail, such as ORA_HTS_PAID_BREAK.
• startTime: string (date-time)
  Start time of the shift detail, entered with the time zone offset.
• startTimeOffset: integer (int64)
  Time zone offset for the shift detail start time.

{
    "type":"object",
    "properties":{
        "endTime":{
            "type":"string",
            "description":"End time of the shift detail, entered with the time zone offset.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "endTimeOffset":{
            "type":"integer",
            "description":"Time zone offset for the shift detail end time.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":22
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "schedEventNumber":{
            "maxLength":120,
            "type":"string",
            "description":"Unique identifier of the schedule event.",
            "nullable":true,
            "x-queryable":true
        },
        "schedRequestNumber":{
            "maxLength":120,
            "type":"string",
            "description":"Unique identifier of the schedule request.",
            "nullable":true,
            "x-queryable":true
        },
        "schedShiftDetailEventId":{
            "type":"integer",
            "description":"Surrogate ID for the schedule shift detail event, available only to reference existing records.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "schedShiftEventId":{
            "type":"integer",
            "description":"Unique identifier to reference the schedule shift event containing the shift detail.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "schedShiftEventNumber":{
            "maxLength":120,
            "type":"string",
            "description":"Unique identifier of the schedule shift event.",
            "nullable":true,
            "x-queryable":true
        },
        "shiftDetailAction":{
            "maxLength":10,
            "type":"string",
            "description":"Action to perform on the shift detail, such as CREATE, UPDATE, or DELETE.",
            "nullable":true,
            "x-queryable":true
        },
        "shiftDetailEndTime":{
            "maxLength":80,
            "type":"string",
            "description":"End time of the shift detail as a string value.",
            "nullable":true,
            "x-queryable":true
        },
        "shiftDetailEventNumber":{
            "maxLength":120,
            "type":"string",
            "description":"Unique identifier of the shift detail event in the source system.",
            "nullable":true,
            "x-queryable":true
        },
        "shiftDetailNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Unique identifier of the shift detail in the source system. It's mandatory only when you update or delete shift details.",
            "nullable":true,
            "x-queryable":true
        },
        "shiftDetailStartTime":{
            "maxLength":80,
            "type":"string",
            "description":"Start time of the shift detail as a string value.",
            "nullable":true,
            "x-queryable":true
        },
        "shiftDetailType":{
            "maxLength":30,
            "type":"string",
            "description":"Type of shift detail, such as ORA_HTS_PAID_BREAK.",
            "nullable":true,
            "x-queryable":true
        },
        "startTime":{
            "type":"string",
            "description":"Start time of the shift detail, entered with the time zone offset.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "startTimeOffset":{
            "type":"integer",
            "description":"Time zone offset for the shift detail start time.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":22
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top