AlphaAlpha Docs
API Reference

H R Leave Request

API calls for HR leave requests

Create a leave request

POST
/hr/leave-requests

Authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/hr/leave-requests" \  -H "Content-Type: application/json" \  -d '{    "employeeId": "string",    "endDate": "2019-08-24",    "endHalf": "FULL",    "leaveType": "VACATION",    "startDate": "2019-08-24",    "startHalf": "FULL"  }'
{
  "approvedAt": "2019-08-24T14:15:22Z",
  "approvedBy": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "employee": {
    "avatar": "string",
    "department": "string",
    "email": "string",
    "fullName": "string",
    "id": "string",
    "jobTitle": "string"
  },
  "employeeId": "string",
  "endDate": "2019-08-24",
  "endHalf": "FULL",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "leaveType": "VACATION",
  "reason": "string",
  "rejectionReason": "string",
  "startDate": "2019-08-24",
  "startHalf": "FULL",
  "status": "PENDING",
  "tenantId": "string",
  "totalDays": 0.1,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Get by employee

GET
/hr/leave-requests/by-employee/{employeeId}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

employeeId*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/hr/leave-requests/by-employee/string"
[
  {
    "approvedAt": "2019-08-24T14:15:22Z",
    "approvedBy": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "employee": {
      "avatar": "string",
      "department": "string",
      "email": "string",
      "fullName": "string",
      "id": "string",
      "jobTitle": "string"
    },
    "employeeId": "string",
    "endDate": "2019-08-24",
    "endHalf": "FULL",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "id": "string",
    "leaveType": "VACATION",
    "reason": "string",
    "rejectionReason": "string",
    "startDate": "2019-08-24",
    "startHalf": "FULL",
    "status": "PENDING",
    "tenantId": "string",
    "totalDays": 0.1,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string"
  }
]
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Download Csv_ Leave Request

GET
/hr/leave-requests/csv-export

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

search?array<>
filters?array<>
page?integer
Default0
Formatint32
size?integer
Default20
Formatint32
sort?string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/hr/leave-requests/csv-export"
"string"
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Delete a list of entities by their IDs

DELETE
/hr/leave-requests/delete-list

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

ids*array<>

Response Body

application/json

application/json

application/json

curl -X DELETE "http://localhost:18080/api/v1/hr/leave-requests/delete-list?ids=string"
Empty
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Dynamic search leave requests

GET
/hr/leave-requests/dynamic-search

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

search?array<>
filters?array<>
page?integer
Default0
Formatint32
size?integer
Default20
Formatint32
sort?string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/hr/leave-requests/dynamic-search"
{
  "content": [
    {
      "approvedAt": "2019-08-24T14:15:22Z",
      "approvedBy": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "employeeId": "string",
      "endDate": "2019-08-24",
      "endHalf": "FULL",
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "id": "string",
      "leaveType": "VACATION",
      "reason": "string",
      "rejectionReason": "string",
      "startDate": "2019-08-24",
      "startHalf": "FULL",
      "status": "PENDING",
      "tenantId": "string",
      "totalDays": 0.1,
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "pageable": {
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 0,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 0,
  "totalPages": 0
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Dynamic Search Post_ Leave Request

POST
/hr/leave-requests/dynamic-search

Authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/hr/leave-requests/dynamic-search" \  -H "Content-Type: application/json" \  -d '{    "filters": {      "property1": null,      "property2": null    },    "page": 0,    "search": [      "string"    ],    "size": 0,    "sort": [      {        "ascending": true,        "field": "string"      }    ]  }'
{
  "content": [
    {
      "approvedAt": "2019-08-24T14:15:22Z",
      "approvedBy": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "employeeId": "string",
      "endDate": "2019-08-24",
      "endHalf": "FULL",
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "id": "string",
      "leaveType": "VACATION",
      "reason": "string",
      "rejectionReason": "string",
      "startDate": "2019-08-24",
      "startHalf": "FULL",
      "status": "PENDING",
      "tenantId": "string",
      "totalDays": 0.1,
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "pageable": {
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 0,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 0,
  "totalPages": 0
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Find by list of ids in current tenant

GET
/hr/leave-requests/find

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

ids*array<>

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/hr/leave-requests/find?ids=string"
[
  {
    "approvedAt": "2019-08-24T14:15:22Z",
    "approvedBy": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "employeeId": "string",
    "endDate": "2019-08-24",
    "endHalf": "FULL",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "id": "string",
    "leaveType": "VACATION",
    "reason": "string",
    "rejectionReason": "string",
    "startDate": "2019-08-24",
    "startHalf": "FULL",
    "status": "PENDING",
    "tenantId": "string",
    "totalDays": 0.1,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string"
  }
]
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Find all for current tenant

GET
/hr/leave-requests/find-all

Authorization

AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/hr/leave-requests/find-all"
[
  {
    "approvedAt": "2019-08-24T14:15:22Z",
    "approvedBy": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "employeeId": "string",
    "endDate": "2019-08-24",
    "endHalf": "FULL",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "id": "string",
    "leaveType": "VACATION",
    "reason": "string",
    "rejectionReason": "string",
    "startDate": "2019-08-24",
    "startHalf": "FULL",
    "status": "PENDING",
    "tenantId": "string",
    "totalDays": 0.1,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string"
  }
]
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Find a list of entities by their IDs

GET
/hr/leave-requests/find-list

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

ids?array<>

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/hr/leave-requests/find-list"
[
  {
    "approvedAt": "2019-08-24T14:15:22Z",
    "approvedBy": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "employeeId": "string",
    "endDate": "2019-08-24",
    "endHalf": "FULL",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "id": "string",
    "leaveType": "VACATION",
    "reason": "string",
    "rejectionReason": "string",
    "startDate": "2019-08-24",
    "startHalf": "FULL",
    "status": "PENDING",
    "tenantId": "string",
    "totalDays": 0.1,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string"
  }
]
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Find by id in current tenant

GET
/hr/leave-requests/find/{id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/hr/leave-requests/find/string"
{
  "approvedAt": "2019-08-24T14:15:22Z",
  "approvedBy": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "employeeId": "string",
  "endDate": "2019-08-24",
  "endHalf": "FULL",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "leaveType": "VACATION",
  "reason": "string",
  "rejectionReason": "string",
  "startDate": "2019-08-24",
  "startHalf": "FULL",
  "status": "PENDING",
  "tenantId": "string",
  "totalDays": 0.1,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Get my leave requests

GET
/hr/leave-requests/my

Authorization

AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/hr/leave-requests/my"
[
  {
    "approvedAt": "2019-08-24T14:15:22Z",
    "approvedBy": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "employee": {
      "avatar": "string",
      "department": "string",
      "email": "string",
      "fullName": "string",
      "id": "string",
      "jobTitle": "string"
    },
    "employeeId": "string",
    "endDate": "2019-08-24",
    "endHalf": "FULL",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "id": "string",
    "leaveType": "VACATION",
    "reason": "string",
    "rejectionReason": "string",
    "startDate": "2019-08-24",
    "startHalf": "FULL",
    "status": "PENDING",
    "tenantId": "string",
    "totalDays": 0.1,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string"
  }
]
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Get my upcoming leave

GET
/hr/leave-requests/my/upcoming

Authorization

AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/hr/leave-requests/my/upcoming"
[
  {
    "approvedAt": "2019-08-24T14:15:22Z",
    "approvedBy": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "employee": {
      "avatar": "string",
      "department": "string",
      "email": "string",
      "fullName": "string",
      "id": "string",
      "jobTitle": "string"
    },
    "employeeId": "string",
    "endDate": "2019-08-24",
    "endHalf": "FULL",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "id": "string",
    "leaveType": "VACATION",
    "reason": "string",
    "rejectionReason": "string",
    "startDate": "2019-08-24",
    "startHalf": "FULL",
    "status": "PENDING",
    "tenantId": "string",
    "totalDays": 0.1,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string"
  }
]
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Get paginated leave requests

GET
/hr/leave-requests/page

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

pageNumber?integer
Formatint32
pageSize?integer
Formatint32
sortBy?string
direction?string
Value in"ASC" | "DESC"
search?string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/hr/leave-requests/page"
{
  "content": [
    {
      "approvedAt": "2019-08-24T14:15:22Z",
      "approvedBy": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "employeeId": "string",
      "endDate": "2019-08-24",
      "endHalf": "FULL",
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "id": "string",
      "leaveType": "VACATION",
      "reason": "string",
      "rejectionReason": "string",
      "startDate": "2019-08-24",
      "startHalf": "FULL",
      "status": "PENDING",
      "tenantId": "string",
      "totalDays": 0.1,
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "pageable": {
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 0,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 0,
  "totalPages": 0
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Get pending approval

GET
/hr/leave-requests/pending-approval

Authorization

AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/hr/leave-requests/pending-approval"
[
  {
    "approvedAt": "2019-08-24T14:15:22Z",
    "approvedBy": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "employee": {
      "avatar": "string",
      "department": "string",
      "email": "string",
      "fullName": "string",
      "id": "string",
      "jobTitle": "string"
    },
    "employeeId": "string",
    "endDate": "2019-08-24",
    "endHalf": "FULL",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "id": "string",
    "leaveType": "VACATION",
    "reason": "string",
    "rejectionReason": "string",
    "startDate": "2019-08-24",
    "startHalf": "FULL",
    "status": "PENDING",
    "tenantId": "string",
    "totalDays": 0.1,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string"
  }
]
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Get team leave

GET
/hr/leave-requests/team

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

start?string
Formatdate
end?string
Formatdate

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/hr/leave-requests/team"
[
  {
    "approvedAt": "2019-08-24T14:15:22Z",
    "approvedBy": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "employee": {
      "avatar": "string",
      "department": "string",
      "email": "string",
      "fullName": "string",
      "id": "string",
      "jobTitle": "string"
    },
    "employeeId": "string",
    "endDate": "2019-08-24",
    "endHalf": "FULL",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "id": "string",
    "leaveType": "VACATION",
    "reason": "string",
    "rejectionReason": "string",
    "startDate": "2019-08-24",
    "startHalf": "FULL",
    "status": "PENDING",
    "tenantId": "string",
    "totalDays": 0.1,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string"
  }
]
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Get enriched leave request

GET
/hr/leave-requests/{id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/hr/leave-requests/string"
{
  "approvedAt": "2019-08-24T14:15:22Z",
  "approvedBy": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "employee": {
    "avatar": "string",
    "department": "string",
    "email": "string",
    "fullName": "string",
    "id": "string",
    "jobTitle": "string"
  },
  "employeeId": "string",
  "endDate": "2019-08-24",
  "endHalf": "FULL",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "leaveType": "VACATION",
  "reason": "string",
  "rejectionReason": "string",
  "startDate": "2019-08-24",
  "startHalf": "FULL",
  "status": "PENDING",
  "tenantId": "string",
  "totalDays": 0.1,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Update a leave request

PATCH
/hr/leave-requests/{id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "http://localhost:18080/api/v1/hr/leave-requests/string" \  -H "Content-Type: application/json" \  -d '{    "employeeId": "string",    "endDate": "2019-08-24",    "endHalf": "FULL",    "leaveType": "VACATION",    "startDate": "2019-08-24",    "startHalf": "FULL"  }'
{
  "approvedAt": "2019-08-24T14:15:22Z",
  "approvedBy": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "employee": {
    "avatar": "string",
    "department": "string",
    "email": "string",
    "fullName": "string",
    "id": "string",
    "jobTitle": "string"
  },
  "employeeId": "string",
  "endDate": "2019-08-24",
  "endHalf": "FULL",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "leaveType": "VACATION",
  "reason": "string",
  "rejectionReason": "string",
  "startDate": "2019-08-24",
  "startHalf": "FULL",
  "status": "PENDING",
  "tenantId": "string",
  "totalDays": 0.1,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Delete by id in current tenant

DELETE
/hr/leave-requests/{id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

curl -X DELETE "http://localhost:18080/api/v1/hr/leave-requests/string"
Empty
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Approve a leave request

POST
/hr/leave-requests/{id}/approve

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/hr/leave-requests/string/approve"
{
  "approvedAt": "2019-08-24T14:15:22Z",
  "approvedBy": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "employee": {
    "avatar": "string",
    "department": "string",
    "email": "string",
    "fullName": "string",
    "id": "string",
    "jobTitle": "string"
  },
  "employeeId": "string",
  "endDate": "2019-08-24",
  "endHalf": "FULL",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "leaveType": "VACATION",
  "reason": "string",
  "rejectionReason": "string",
  "startDate": "2019-08-24",
  "startHalf": "FULL",
  "status": "PENDING",
  "tenantId": "string",
  "totalDays": 0.1,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Cancel a leave request

POST
/hr/leave-requests/{id}/cancel

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/hr/leave-requests/string/cancel"
{
  "approvedAt": "2019-08-24T14:15:22Z",
  "approvedBy": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "employee": {
    "avatar": "string",
    "department": "string",
    "email": "string",
    "fullName": "string",
    "id": "string",
    "jobTitle": "string"
  },
  "employeeId": "string",
  "endDate": "2019-08-24",
  "endHalf": "FULL",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "leaveType": "VACATION",
  "reason": "string",
  "rejectionReason": "string",
  "startDate": "2019-08-24",
  "startHalf": "FULL",
  "status": "PENDING",
  "tenantId": "string",
  "totalDays": 0.1,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Add a comment to an entity

POST
/hr/leave-requests/{id}/comment

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

body*string

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/hr/leave-requests/string/comment" \  -H "Content-Type: application/json" \  -d 'string'
{}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Reject a leave request

POST
/hr/leave-requests/{id}/reject

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

reason*string

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/hr/leave-requests/string/reject" \  -H "Content-Type: application/json" \  -d '{    "reason": "string"  }'
{
  "approvedAt": "2019-08-24T14:15:22Z",
  "approvedBy": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "employee": {
    "avatar": "string",
    "department": "string",
    "email": "string",
    "fullName": "string",
    "id": "string",
    "jobTitle": "string"
  },
  "employeeId": "string",
  "endDate": "2019-08-24",
  "endHalf": "FULL",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "leaveType": "VACATION",
  "reason": "string",
  "rejectionReason": "string",
  "startDate": "2019-08-24",
  "startHalf": "FULL",
  "status": "PENDING",
  "tenantId": "string",
  "totalDays": 0.1,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

H R Feature

Previous Page

H R Project

Next Page