Update a schedule process
patch
/hcmRestApi/resources/11.13.18.05/scheduleProcesses/{ScheduleProcessId}
Request
Path Parameters
-
ScheduleProcessId(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:
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
JobParameters: string
Maximum Length:
4000
Parameters of the given schedule process. -
JobRequestId: integer
(int64)
Unique identifier for the schedule process request.
-
JobTypeCode: string
Maximum Length:
30
Type of schedule process, such as SCHEDULE_GENERATION or WORKLOAD_GENERATION. -
ObjectVersionNumber: integer
(int32)
Internal object version number.
-
ProcessEndTime: string
(date-time)
End time of the schedule process.
-
ProcessStartTime: string
(date-time)
Start time of the schedule process.
-
ScheduleUnitProcesses: array
Schedule Unit Processes
Title:
Schedule Unit Processes
The schedule process associated with the schedule unit. -
StatusCode: string
Maximum Length:
30
Status of the submitted schedule process.
Nested Schema : Schedule Unit Processes
Type:
array
Title:
Schedule Unit Processes
The schedule process associated with the schedule unit.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
EndDate: string
(date)
End date of the period to run the schedule unit process for.
-
JobParameters: string
Maximum Length:
4000
Parameters of the given schedule unit process. -
JobRequestId: integer
(int64)
Unique identifier for the schedule unit process request.
-
JobTypeCode: string
Maximum Length:
30
Type of schedule unit process. -
ObjectVersionNumber: integer
(int32)
Internal object version number.
-
ProcessEndTime: string
(date-time)
End time of the schedule unit process.
-
ProcessStartTime: string
(date-time)
Start time of the schedule unit process.
-
ScheduleGenProfileId: integer
(int64)
Unique identifier of the process that runs the schedule unit process.
-
ScheduleProcessId: integer
(int64)
Unique identifier for the schedule process.
-
ScheduleUnitId: integer
(int64)
Unique identifier for the schedule unit.
-
StartDate: string
(date)
Start date of the period to run the schedule unit process for.
-
StatusCode: string
Maximum Length:
30
Status of the submitted schedule unit process.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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.
Root Schema : scheduleProcesses-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The person who created the schedule process. -
CreationDate: string
(date-time)
Read Only:
true
The date when the schedule process was created. -
JobParameters: string
Maximum Length:
4000
Parameters of the given schedule process. -
JobRequestId: integer
(int64)
Unique identifier for the schedule process request.
-
JobTypeCode: string
Maximum Length:
30
Type of schedule process, such as SCHEDULE_GENERATION or WORKLOAD_GENERATION. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the schedule process was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The person who last updated the schedule process. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Internal object version number.
-
ProcessEndTime: string
(date-time)
End time of the schedule process.
-
ProcessStartTime: string
(date-time)
Start time of the schedule process.
-
ScheduleProcessId: integer
(int64)
Unique identifier for the schedule process.
-
ScheduleUnitProcesses: array
Schedule Unit Processes
Title:
Schedule Unit Processes
The schedule process associated with the schedule unit. -
StatusCode: string
Maximum Length:
30
Status of the submitted schedule process.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Schedule Unit Processes
Type:
array
Title:
Schedule Unit Processes
The schedule process associated with the schedule unit.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : scheduleProcesses-ScheduleUnitProcesses-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The person who created the schedule unit process. -
CreationDate: string
(date-time)
Read Only:
true
The date when the schedule unit process was created. -
EndDate: string
(date)
End date of the period to run the schedule unit process for.
-
JobParameters: string
Maximum Length:
4000
Parameters of the given schedule unit process. -
JobRequestId: integer
(int64)
Unique identifier for the schedule unit process request.
-
JobTypeCode: string
Maximum Length:
30
Type of schedule unit process. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the schedule unit process was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The person who last updated the schedule unit process. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Internal object version number.
-
ProcessEndTime: string
(date-time)
End time of the schedule unit process.
-
ProcessStartTime: string
(date-time)
Start time of the schedule unit process.
-
ScheduleGenProfileId: integer
(int64)
Unique identifier of the process that runs the schedule unit process.
-
ScheduleProcessId: integer
(int64)
Unique identifier for the schedule process.
-
ScheduleUnitId: integer
(int64)
Unique identifier for the schedule unit.
-
ScheduleUnitProcessId: integer
(int64)
Unique identifier for the schedule unit process.
-
StartDate: string
(date)
Start date of the period to run the schedule unit process for.
-
StatusCode: string
Maximum Length:
30
Status of the submitted schedule unit process.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- ScheduleUnitProcesses
-
Operation: /hcmRestApi/resources/11.13.18.05/scheduleProcesses/{ScheduleProcessId}/child/ScheduleUnitProcessesParameters:
- ScheduleProcessId:
$request.path.ScheduleProcessId
The schedule process associated with the schedule unit. - ScheduleProcessId: