Update a maternity absence record
patch
/hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceMaternity/{personAbsenceMaternityId}
Request
Path Parameters
-
absencesUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Absences resource and used to uniquely identify an instance of Absences. The client should not generate the hash key value. Instead, the client should query on the Absences collection resource in order to navigate to a specific instance of Absences to get the hash key.
-
personAbsenceMaternityId(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
-
actualChildBirthDate: string
(date)
Title:
Actual Childbirth Date
Actual date of childbirth or placement. -
actualReturnDate: string
(date)
Title:
Actual End Date
Actual return date of maternity leave. -
actualStartDate: string
(date)
Title:
Actual Start Date
Actual start date of maternity leave. -
expectedDateOfChildBirth: string
(date)
Title:
Expected Childbirth Date
Expected date of childbirth or placement. -
expectedEndDate: string
(date)
Title:
Estimated End Date
Expected end date of maternity leave. -
intendToWorkFlag: boolean
Title:
Won't return to work
Maximum Length:30
Indicates whether the absence can be submitted without a planned return date. Used for maternity absence only. The default value is true. -
matchingDate: string
(date)
Title:
Placement Match Date
Date field to be used by localization team. -
openEndedFlag: boolean
Title:
Mark as open ended
Maximum Length:30
Indicates whether the absence can be submitted without an absence end date. The default value is false. -
plannedReturnDate: string
(date)
Title:
Planned End Date
Planned end date of maternity leave. -
plannedStartDate: string
(date)
Title:
Planned Start Date
Planned start date of maternity leave.
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.
Root Schema : absences-absenceMaternity-item-response
Type:
Show Source
object
-
actualChildBirthDate: string
(date)
Title:
Actual Childbirth Date
Actual date of childbirth or placement. -
actualDuration: number
Title:
Actual Duration
Actual duration of maternity leave. -
actualReturnDate: string
(date)
Title:
Actual End Date
Actual return date of maternity leave. -
actualStartDate: string
(date)
Title:
Actual Start Date
Actual start date of maternity leave. -
createdBy: string
Read Only:
true
Maximum Length:64
Name of the employee who created the maternity absence record. -
creationDate: string
(date-time)
Read Only:
true
Date and time of the maternity absence record creation. -
expectedDateOfChildBirth: string
(date)
Title:
Expected Childbirth Date
Expected date of childbirth or placement. -
expectedEndDate: string
(date)
Title:
Estimated End Date
Expected end date of maternity leave. -
expectedWeekOfChildBirth: string
(date)
Expected week of maternity leave. This is Monday of the week in which the expected date of childbirth falls.
-
formattedActualDuration: string
Title:
Actual Duration
Read Only:true
Maximum Length:255
Actual duration of the childbirth or placement absence. -
formattedLeaveDuration: string
Title:
Planned Duration
Read Only:true
Maximum Length:255
Actual duration of the absence leave. -
intendToWorkFlag: boolean
Title:
Won't return to work
Maximum Length:30
Indicates whether the absence can be submitted without a planned return date. Used for maternity absence only. The default value is true. -
lastUpdateDate: string
(date-time)
Read Only:
true
Latest date and time of the maternity absence record update. -
lastUpdatedBy: string
Read Only:
true
Maximum Length:64
Name of the employee who updated the maternity absence record most recently. -
lastUpdateLogin: string
Read Only:
true
Maximum Length:32
Login identifier of employee who last updated the maternity record. -
leaveDuration: number
Title:
Planned Duration
Planned maternity leave duration. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
matchingDate: string
(date)
Title:
Placement Match Date
Date field to be used by localization team. -
openEndedFlag: boolean
Title:
Mark as open ended
Maximum Length:30
Indicates whether the absence can be submitted without an absence end date. The default value is false. -
personAbsenceEntryId: integer
(int64)
Unique identifier for the absence.
-
personAbsenceMaternityId: integer
(int64)
Unique identifier of a maternity record of absence.
-
plannedReturnDate: string
(date)
Title:
Planned End Date
Planned end date of maternity leave. -
plannedStartDate: string
(date)
Title:
Planned Start Date
Planned start date of maternity leave.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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.