Jump to

• Request
• Response

Create a maternity absence record

post

/hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceMaternity

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.

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.
• Upsert-Mode: string
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.
• 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.
• 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.
• leaveDuration: number
  Title: Planned Duration

  Planned maternity leave duration.
• 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.

{
    "type":"object",
    "properties":{
        "actualChildBirthDate":{
            "title":"Actual Childbirth Date",
            "type":"string",
            "description":"Actual date of childbirth or placement.",
            "format":"date",
            "nullable":true
        },
        "actualDuration":{
            "title":"Actual Duration",
            "type":"number",
            "description":"Actual duration of maternity leave.",
            "nullable":true
        },
        "actualReturnDate":{
            "title":"Actual End Date",
            "type":"string",
            "description":"Actual return date of maternity leave.",
            "format":"date",
            "nullable":true
        },
        "actualStartDate":{
            "title":"Actual Start Date",
            "type":"string",
            "description":"Actual start date of maternity leave.",
            "format":"date",
            "nullable":true
        },
        "expectedDateOfChildBirth":{
            "title":"Expected Childbirth Date",
            "type":"string",
            "description":"Expected date of childbirth or placement.",
            "format":"date",
            "nullable":true
        },
        "expectedEndDate":{
            "title":"Estimated End Date",
            "type":"string",
            "description":"Expected end date of maternity leave.",
            "format":"date",
            "nullable":true
        },
        "expectedWeekOfChildBirth":{
            "type":"string",
            "description":"Expected week of maternity leave. This is Monday of the week in which the expected date of childbirth falls.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "Property":"Value"
            }
        },
        "intendToWorkFlag":{
            "title":"Won't return to work",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether the absence can be submitted without a planned return date. Used for maternity absence only. The default value is true.",
            "nullable":true
        },
        "leaveDuration":{
            "title":"Planned Duration",
            "type":"number",
            "description":"Planned maternity leave duration.",
            "nullable":true
        },
        "matchingDate":{
            "title":"Placement Match Date",
            "type":"string",
            "description":"Date field to be used by localization team.",
            "format":"date",
            "nullable":true
        },
        "openEndedFlag":{
            "title":"Mark as open ended",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether the absence can be submitted without an absence end date. The default value is false.",
            "nullable":true
        },
        "personAbsenceEntryId":{
            "type":"integer",
            "description":"Unique identifier for the absence.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "personAbsenceMaternityId":{
            "type":"integer",
            "description":"Unique identifier of a maternity record of absence.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "plannedReturnDate":{
            "title":"Planned End Date",
            "type":"string",
            "description":"Planned end date of maternity leave.",
            "format":"date",
            "nullable":true
        },
        "plannedStartDate":{
            "title":"Planned Start Date",
            "type":"string",
            "description":"Planned start date of maternity leave.",
            "format":"date",
            "nullable":true
        }
    }
}

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 : absences-absenceMaternity-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "actualChildBirthDate":{
            "title":"Actual Childbirth Date",
            "type":"string",
            "description":"Actual date of childbirth or placement.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "actualDuration":{
            "title":"Actual Duration",
            "type":"number",
            "description":"Actual duration of maternity leave.",
            "nullable":true,
            "x-queryable":true
        },
        "actualReturnDate":{
            "title":"Actual End Date",
            "type":"string",
            "description":"Actual return date of maternity leave.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "actualStartDate":{
            "title":"Actual Start Date",
            "type":"string",
            "description":"Actual start date of maternity leave.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "createdBy":{
            "maxLength":64,
            "type":"string",
            "description":"Name of the employee who created the maternity absence record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "creationDate":{
            "type":"string",
            "description":"Date and time of the maternity absence record creation.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "expectedDateOfChildBirth":{
            "title":"Expected Childbirth Date",
            "type":"string",
            "description":"Expected date of childbirth or placement.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "expectedEndDate":{
            "title":"Estimated End Date",
            "type":"string",
            "description":"Expected end date of maternity leave.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "expectedWeekOfChildBirth":{
            "type":"string",
            "description":"Expected week of maternity leave. This is Monday of the week in which the expected date of childbirth falls.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "Property":"Value"
            },
            "x-queryable":true
        },
        "formattedActualDuration":{
            "title":"Actual Duration",
            "maxLength":255,
            "type":"string",
            "description":"Actual duration of the childbirth or placement absence.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "formattedLeaveDuration":{
            "title":"Planned Duration",
            "maxLength":255,
            "type":"string",
            "description":"Actual duration of the absence leave.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "intendToWorkFlag":{
            "title":"Won't return to work",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether the absence can be submitted without a planned return date. Used for maternity absence only. The default value is true.",
            "nullable":true,
            "x-queryable":true
        },
        "lastUpdateDate":{
            "type":"string",
            "description":"Latest date and time of the maternity absence record update.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "lastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Login identifier of employee who last updated the maternity record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "lastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Name of the employee who updated the maternity absence record most recently.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "leaveDuration":{
            "title":"Planned Duration",
            "type":"number",
            "description":"Planned maternity leave duration.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "matchingDate":{
            "title":"Placement Match Date",
            "type":"string",
            "description":"Date field to be used by localization team.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "openEndedFlag":{
            "title":"Mark as open ended",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether the absence can be submitted without an absence end date. The default value is false.",
            "nullable":true,
            "x-queryable":true
        },
        "personAbsenceEntryId":{
            "type":"integer",
            "description":"Unique identifier for the absence.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "personAbsenceMaternityId":{
            "type":"integer",
            "description":"Unique identifier of a maternity record of absence.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "plannedReturnDate":{
            "title":"Planned End Date",
            "type":"string",
            "description":"Planned end date of maternity leave.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "plannedStartDate":{
            "title":"Planned Start Date",
            "type":"string",
            "description":"Planned start date of maternity leave.",
            "format":"date",
            "nullable":true,
            "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