Jump to

• Request
• Response

Check active scheduling profile.

post

/hcmRestApi/resources/11.13.18.05/absences/action/checkActiveSchedulingProfile

Checks active scheduling profile exists or not for a given employee and absence type.

Request

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/vnd.oracle.adf.action+json

Request Body - application/vnd.oracle.adf.action+json ()

Root Schema : schema

Type: object

Show Source

• assignmentId: number
  Unique identifier of an assignment.
• personId: number
  Unique identifier for a person.
• startDate: string (date)
  Start date when the scheduling profile became active.
• typeId: number
  Unique identifier for an absence type.
• userMode: string
  Mode of the user.

{
    "type":"object",
    "properties":{
        "userMode":{
            "type":"string",
            "description":"Mode of the user.",
            "nullable":true
        },
        "personId":{
            "type":"number",
            "description":"Unique identifier for a person.",
            "nullable":true
        },
        "typeId":{
            "type":"number",
            "description":"Unique identifier for an absence type.",
            "nullable":true
        },
        "assignmentId":{
            "type":"number",
            "description":"Unique identifier of an assignment.",
            "nullable":true
        },
        "startDate":{
            "type":"string",
            "description":"Start date when the scheduling profile became active.",
            "format":"date",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.adf.actionresult+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : schema

Type: object

Show Source

• result(required): object result
  Additional Properties Allowed: additionalProperties

  Return of success or failure.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Return of success or failure."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Return of success or failure."
}

Return of success or failure.

Back to Top