Alpha H R Employee
API calls for HR employees
Create an employee
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/employees" \ -H "Content-Type: application/json" \ -d '{ "email": "string", "firstName": "string", "lastName": "string", "status": "ACTIVE" }'{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"attachments": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"avatar": "string",
"contracts": [
{
"attachments": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"currency": "string",
"endDate": "2019-08-24",
"hours": 0.1,
"hoursType": "WEEKLY",
"id": "string",
"maxHours": 0.1,
"notes": "string",
"salary": 0.1,
"salaryType": "HOURLY",
"startDate": "2019-08-24",
"type": "PERMANENT"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"department": "string",
"email": "string",
"endDate": "2019-08-24",
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"firstName": "string",
"fullName": "string",
"githubUsername": "string",
"hourSettings": {
"currency": "string",
"hourlyRate": 0.1,
"requireTaskLink": true,
"trackingStartDate": "2019-08-24",
"weeklyHourTarget": 0.1
},
"id": "string",
"jobTitle": "string",
"lastName": "string",
"linkedinUrl": "string",
"manager": {
"avatar": "string",
"department": "string",
"email": "string",
"fullName": "string",
"id": "string",
"jobTitle": "string"
},
"managerId": "string",
"phone": "string",
"startDate": "2019-08-24",
"status": "ACTIVE",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"user": {
"displayName": "string",
"id": "string",
"username": "string"
},
"userId": "string",
"vacationBalances": [
{
"adjustments": 0.1,
"carriedOver": 0.1,
"notes": "string",
"totalDays": 0.1,
"usedDays": 0.1,
"year": 0
}
],
"workSchedule": {
"entries": [
{
"dayOfWeek": "MONDAY",
"isWorkDay": true,
"slots": [
{
"endTime": "string",
"startTime": "string"
}
],
"workDay": true
}
]
}
}{
"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 active employees
AuthorizationBearer <token>
In: header
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/hr/employees/active"[
{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"attachments": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"avatar": "string",
"contracts": [
{
"attachments": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"currency": "string",
"endDate": "2019-08-24",
"hours": 0.1,
"hoursType": "WEEKLY",
"id": "string",
"maxHours": 0.1,
"notes": "string",
"salary": 0.1,
"salaryType": "HOURLY",
"startDate": "2019-08-24",
"type": "PERMANENT"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"department": "string",
"email": "string",
"endDate": "2019-08-24",
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"firstName": "string",
"fullName": "string",
"githubUsername": "string",
"hourSettings": {
"currency": "string",
"hourlyRate": 0.1,
"requireTaskLink": true,
"trackingStartDate": "2019-08-24",
"weeklyHourTarget": 0.1
},
"id": "string",
"jobTitle": "string",
"lastName": "string",
"linkedinUrl": "string",
"managerId": "string",
"phone": "string",
"startDate": "2019-08-24",
"status": "ACTIVE",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"userId": "string",
"vacationBalances": [
{
"adjustments": 0.1,
"carriedOver": 0.1,
"notes": "string",
"totalDays": 0.1,
"usedDays": 0.1,
"year": 0
}
],
"workSchedule": {
"entries": [
{
"dayOfWeek": "MONDAY",
"isWorkDay": true,
"slots": [
{
"endTime": "string",
"startTime": "string"
}
],
"workDay": true
}
]
}
}
]{
"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 employees by department
AuthorizationBearer <token>
In: header
Path Parameters
department*string
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/hr/employees/by-department/string"[
{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"attachments": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"avatar": "string",
"contracts": [
{
"attachments": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"currency": "string",
"endDate": "2019-08-24",
"hours": 0.1,
"hoursType": "WEEKLY",
"id": "string",
"maxHours": 0.1,
"notes": "string",
"salary": 0.1,
"salaryType": "HOURLY",
"startDate": "2019-08-24",
"type": "PERMANENT"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"department": "string",
"email": "string",
"endDate": "2019-08-24",
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"firstName": "string",
"fullName": "string",
"githubUsername": "string",
"hourSettings": {
"currency": "string",
"hourlyRate": 0.1,
"requireTaskLink": true,
"trackingStartDate": "2019-08-24",
"weeklyHourTarget": 0.1
},
"id": "string",
"jobTitle": "string",
"lastName": "string",
"linkedinUrl": "string",
"managerId": "string",
"phone": "string",
"startDate": "2019-08-24",
"status": "ACTIVE",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"userId": "string",
"vacationBalances": [
{
"adjustments": 0.1,
"carriedOver": 0.1,
"notes": "string",
"totalDays": 0.1,
"usedDays": 0.1,
"year": 0
}
],
"workSchedule": {
"entries": [
{
"dayOfWeek": "MONDAY",
"isWorkDay": true,
"slots": [
{
"endTime": "string",
"startTime": "string"
}
],
"workDay": true
}
]
}
}
]{
"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 employees by manager
AuthorizationBearer <token>
In: header
Path Parameters
managerId*string
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/hr/employees/by-manager/string"[
{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"attachments": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"avatar": "string",
"contracts": [
{
"attachments": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"currency": "string",
"endDate": "2019-08-24",
"hours": 0.1,
"hoursType": "WEEKLY",
"id": "string",
"maxHours": 0.1,
"notes": "string",
"salary": 0.1,
"salaryType": "HOURLY",
"startDate": "2019-08-24",
"type": "PERMANENT"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"department": "string",
"email": "string",
"endDate": "2019-08-24",
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"firstName": "string",
"fullName": "string",
"githubUsername": "string",
"hourSettings": {
"currency": "string",
"hourlyRate": 0.1,
"requireTaskLink": true,
"trackingStartDate": "2019-08-24",
"weeklyHourTarget": 0.1
},
"id": "string",
"jobTitle": "string",
"lastName": "string",
"linkedinUrl": "string",
"managerId": "string",
"phone": "string",
"startDate": "2019-08-24",
"status": "ACTIVE",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"userId": "string",
"vacationBalances": [
{
"adjustments": 0.1,
"carriedOver": 0.1,
"notes": "string",
"totalDays": 0.1,
"usedDays": 0.1,
"year": 0
}
],
"workSchedule": {
"entries": [
{
"dayOfWeek": "MONDAY",
"isWorkDay": true,
"slots": [
{
"endTime": "string",
"startTime": "string"
}
],
"workDay": true
}
]
}
}
]{
"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 employees by status
AuthorizationBearer <token>
In: header
Path Parameters
status*string
Value in
"ACTIVE" | "INACTIVE" | "ON_LEAVE" | "TERMINATED"Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/hr/employees/by-status/ACTIVE"[
{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"attachments": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"avatar": "string",
"contracts": [
{
"attachments": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"currency": "string",
"endDate": "2019-08-24",
"hours": 0.1,
"hoursType": "WEEKLY",
"id": "string",
"maxHours": 0.1,
"notes": "string",
"salary": 0.1,
"salaryType": "HOURLY",
"startDate": "2019-08-24",
"type": "PERMANENT"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"department": "string",
"email": "string",
"endDate": "2019-08-24",
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"firstName": "string",
"fullName": "string",
"githubUsername": "string",
"hourSettings": {
"currency": "string",
"hourlyRate": 0.1,
"requireTaskLink": true,
"trackingStartDate": "2019-08-24",
"weeklyHourTarget": 0.1
},
"id": "string",
"jobTitle": "string",
"lastName": "string",
"linkedinUrl": "string",
"managerId": "string",
"phone": "string",
"startDate": "2019-08-24",
"status": "ACTIVE",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"userId": "string",
"vacationBalances": [
{
"adjustments": 0.1,
"carriedOver": 0.1,
"notes": "string",
"totalDays": 0.1,
"usedDays": 0.1,
"year": 0
}
],
"workSchedule": {
"entries": [
{
"dayOfWeek": "MONDAY",
"isWorkDay": true,
"slots": [
{
"endTime": "string",
"startTime": "string"
}
],
"workDay": true
}
]
}
}
]{
"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_ Employee
AuthorizationBearer <token>
In: header
Query Parameters
search?array<>
filters?array<>
page?integer
Default
0Format
int32size?integer
Default
20Format
int32sort?string
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/hr/employees/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
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/employees/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 employees enriched
AuthorizationBearer <token>
In: header
Query Parameters
search?array<>
filters?array<>
page?integer
Default
0Format
int32size?integer
Default
20Format
int32sort?string
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/hr/employees/dynamic-search"{
"content": [
{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"attachments": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"avatar": "string",
"contracts": [
{
"attachments": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"currency": "string",
"endDate": "2019-08-24",
"hours": 0.1,
"hoursType": "WEEKLY",
"id": "string",
"maxHours": 0.1,
"notes": "string",
"salary": 0.1,
"salaryType": "HOURLY",
"startDate": "2019-08-24",
"type": "PERMANENT"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"department": "string",
"email": "string",
"endDate": "2019-08-24",
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"firstName": "string",
"fullName": "string",
"githubUsername": "string",
"hourSettings": {
"currency": "string",
"hourlyRate": 0.1,
"requireTaskLink": true,
"trackingStartDate": "2019-08-24",
"weeklyHourTarget": 0.1
},
"id": "string",
"jobTitle": "string",
"lastName": "string",
"linkedinUrl": "string",
"managerId": "string",
"phone": "string",
"startDate": "2019-08-24",
"status": "ACTIVE",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"userId": "string",
"vacationBalances": [
{
"adjustments": 0.1,
"carriedOver": 0.1,
"notes": "string",
"totalDays": 0.1,
"usedDays": 0.1,
"year": 0
}
],
"workSchedule": {
"entries": [
{
"dayOfWeek": "MONDAY",
"isWorkDay": true,
"slots": [
{
"endTime": "string",
"startTime": "string"
}
],
"workDay": true
}
]
}
}
],
"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_ Employee
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/employees/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": [
{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"attachments": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"avatar": "string",
"contracts": [
{
"attachments": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"currency": "string",
"endDate": "2019-08-24",
"hours": 0.1,
"hoursType": "WEEKLY",
"id": "string",
"maxHours": 0.1,
"notes": "string",
"salary": 0.1,
"salaryType": "HOURLY",
"startDate": "2019-08-24",
"type": "PERMANENT"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"department": "string",
"email": "string",
"endDate": "2019-08-24",
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"firstName": "string",
"fullName": "string",
"githubUsername": "string",
"hourSettings": {
"currency": "string",
"hourlyRate": 0.1,
"requireTaskLink": true,
"trackingStartDate": "2019-08-24",
"weeklyHourTarget": 0.1
},
"id": "string",
"jobTitle": "string",
"lastName": "string",
"linkedinUrl": "string",
"managerId": "string",
"phone": "string",
"startDate": "2019-08-24",
"status": "ACTIVE",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"userId": "string",
"vacationBalances": [
{
"adjustments": 0.1,
"carriedOver": 0.1,
"notes": "string",
"totalDays": 0.1,
"usedDays": 0.1,
"year": 0
}
],
"workSchedule": {
"entries": [
{
"dayOfWeek": "MONDAY",
"isWorkDay": true,
"slots": [
{
"endTime": "string",
"startTime": "string"
}
],
"workDay": true
}
]
}
}
],
"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
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/employees/find?ids=string"[
{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"attachments": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"avatar": "string",
"contracts": [
{
"attachments": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"currency": "string",
"endDate": "2019-08-24",
"hours": 0.1,
"hoursType": "WEEKLY",
"id": "string",
"maxHours": 0.1,
"notes": "string",
"salary": 0.1,
"salaryType": "HOURLY",
"startDate": "2019-08-24",
"type": "PERMANENT"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"department": "string",
"email": "string",
"endDate": "2019-08-24",
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"firstName": "string",
"fullName": "string",
"githubUsername": "string",
"hourSettings": {
"currency": "string",
"hourlyRate": 0.1,
"requireTaskLink": true,
"trackingStartDate": "2019-08-24",
"weeklyHourTarget": 0.1
},
"id": "string",
"jobTitle": "string",
"lastName": "string",
"linkedinUrl": "string",
"managerId": "string",
"phone": "string",
"startDate": "2019-08-24",
"status": "ACTIVE",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"userId": "string",
"vacationBalances": [
{
"adjustments": 0.1,
"carriedOver": 0.1,
"notes": "string",
"totalDays": 0.1,
"usedDays": 0.1,
"year": 0
}
],
"workSchedule": {
"entries": [
{
"dayOfWeek": "MONDAY",
"isWorkDay": true,
"slots": [
{
"endTime": "string",
"startTime": "string"
}
],
"workDay": true
}
]
}
}
]{
"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
AuthorizationBearer <token>
In: header
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/hr/employees/find-all"[
{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"attachments": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"avatar": "string",
"contracts": [
{
"attachments": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"currency": "string",
"endDate": "2019-08-24",
"hours": 0.1,
"hoursType": "WEEKLY",
"id": "string",
"maxHours": 0.1,
"notes": "string",
"salary": 0.1,
"salaryType": "HOURLY",
"startDate": "2019-08-24",
"type": "PERMANENT"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"department": "string",
"email": "string",
"endDate": "2019-08-24",
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"firstName": "string",
"fullName": "string",
"githubUsername": "string",
"hourSettings": {
"currency": "string",
"hourlyRate": 0.1,
"requireTaskLink": true,
"trackingStartDate": "2019-08-24",
"weeklyHourTarget": 0.1
},
"id": "string",
"jobTitle": "string",
"lastName": "string",
"linkedinUrl": "string",
"managerId": "string",
"phone": "string",
"startDate": "2019-08-24",
"status": "ACTIVE",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"userId": "string",
"vacationBalances": [
{
"adjustments": 0.1,
"carriedOver": 0.1,
"notes": "string",
"totalDays": 0.1,
"usedDays": 0.1,
"year": 0
}
],
"workSchedule": {
"entries": [
{
"dayOfWeek": "MONDAY",
"isWorkDay": true,
"slots": [
{
"endTime": "string",
"startTime": "string"
}
],
"workDay": true
}
]
}
}
]{
"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
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/employees/find-list"[
{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"attachments": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"avatar": "string",
"contracts": [
{
"attachments": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"currency": "string",
"endDate": "2019-08-24",
"hours": 0.1,
"hoursType": "WEEKLY",
"id": "string",
"maxHours": 0.1,
"notes": "string",
"salary": 0.1,
"salaryType": "HOURLY",
"startDate": "2019-08-24",
"type": "PERMANENT"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"department": "string",
"email": "string",
"endDate": "2019-08-24",
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"firstName": "string",
"fullName": "string",
"githubUsername": "string",
"hourSettings": {
"currency": "string",
"hourlyRate": 0.1,
"requireTaskLink": true,
"trackingStartDate": "2019-08-24",
"weeklyHourTarget": 0.1
},
"id": "string",
"jobTitle": "string",
"lastName": "string",
"linkedinUrl": "string",
"managerId": "string",
"phone": "string",
"startDate": "2019-08-24",
"status": "ACTIVE",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"userId": "string",
"vacationBalances": [
{
"adjustments": 0.1,
"carriedOver": 0.1,
"notes": "string",
"totalDays": 0.1,
"usedDays": 0.1,
"year": 0
}
],
"workSchedule": {
"entries": [
{
"dayOfWeek": "MONDAY",
"isWorkDay": true,
"slots": [
{
"endTime": "string",
"startTime": "string"
}
],
"workDay": true
}
]
}
}
]{
"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
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/employees/find/string"{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"attachments": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"avatar": "string",
"contracts": [
{
"attachments": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"currency": "string",
"endDate": "2019-08-24",
"hours": 0.1,
"hoursType": "WEEKLY",
"id": "string",
"maxHours": 0.1,
"notes": "string",
"salary": 0.1,
"salaryType": "HOURLY",
"startDate": "2019-08-24",
"type": "PERMANENT"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"department": "string",
"email": "string",
"endDate": "2019-08-24",
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"firstName": "string",
"fullName": "string",
"githubUsername": "string",
"hourSettings": {
"currency": "string",
"hourlyRate": 0.1,
"requireTaskLink": true,
"trackingStartDate": "2019-08-24",
"weeklyHourTarget": 0.1
},
"id": "string",
"jobTitle": "string",
"lastName": "string",
"linkedinUrl": "string",
"managerId": "string",
"phone": "string",
"startDate": "2019-08-24",
"status": "ACTIVE",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"userId": "string",
"vacationBalances": [
{
"adjustments": 0.1,
"carriedOver": 0.1,
"notes": "string",
"totalDays": 0.1,
"usedDays": 0.1,
"year": 0
}
],
"workSchedule": {
"entries": [
{
"dayOfWeek": "MONDAY",
"isWorkDay": true,
"slots": [
{
"endTime": "string",
"startTime": "string"
}
],
"workDay": true
}
]
}
}{
"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 current employee
AuthorizationBearer <token>
In: header
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/hr/employees/me"{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"attachments": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"avatar": "string",
"contracts": [
{
"attachments": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"currency": "string",
"endDate": "2019-08-24",
"hours": 0.1,
"hoursType": "WEEKLY",
"id": "string",
"maxHours": 0.1,
"notes": "string",
"salary": 0.1,
"salaryType": "HOURLY",
"startDate": "2019-08-24",
"type": "PERMANENT"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"department": "string",
"email": "string",
"endDate": "2019-08-24",
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"firstName": "string",
"fullName": "string",
"githubUsername": "string",
"hourSettings": {
"currency": "string",
"hourlyRate": 0.1,
"requireTaskLink": true,
"trackingStartDate": "2019-08-24",
"weeklyHourTarget": 0.1
},
"id": "string",
"jobTitle": "string",
"lastName": "string",
"linkedinUrl": "string",
"manager": {
"avatar": "string",
"department": "string",
"email": "string",
"fullName": "string",
"id": "string",
"jobTitle": "string"
},
"managerId": "string",
"phone": "string",
"startDate": "2019-08-24",
"status": "ACTIVE",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"user": {
"displayName": "string",
"id": "string",
"username": "string"
},
"userId": "string",
"vacationBalances": [
{
"adjustments": 0.1,
"carriedOver": 0.1,
"notes": "string",
"totalDays": 0.1,
"usedDays": 0.1,
"year": 0
}
],
"workSchedule": {
"entries": [
{
"dayOfWeek": "MONDAY",
"isWorkDay": true,
"slots": [
{
"endTime": "string",
"startTime": "string"
}
],
"workDay": true
}
]
}
}{
"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 vacation balance
AuthorizationBearer <token>
In: header
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/hr/employees/me/vacation-balance"[
{
"adjustments": 0.1,
"carriedOver": 0.1,
"notes": "string",
"totalDays": 0.1,
"usedDays": 0.1,
"year": 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 paginated employees
AuthorizationBearer <token>
In: header
Query Parameters
pageNumber?integer
Format
int32pageSize?integer
Format
int32sortBy?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/employees/page"{
"content": [
{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"attachments": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"avatar": "string",
"contracts": [
{
"attachments": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"currency": "string",
"endDate": "2019-08-24",
"hours": 0.1,
"hoursType": "WEEKLY",
"id": "string",
"maxHours": 0.1,
"notes": "string",
"salary": 0.1,
"salaryType": "HOURLY",
"startDate": "2019-08-24",
"type": "PERMANENT"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"department": "string",
"email": "string",
"endDate": "2019-08-24",
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"firstName": "string",
"fullName": "string",
"githubUsername": "string",
"hourSettings": {
"currency": "string",
"hourlyRate": 0.1,
"requireTaskLink": true,
"trackingStartDate": "2019-08-24",
"weeklyHourTarget": 0.1
},
"id": "string",
"jobTitle": "string",
"lastName": "string",
"linkedinUrl": "string",
"managerId": "string",
"phone": "string",
"startDate": "2019-08-24",
"status": "ACTIVE",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"userId": "string",
"vacationBalances": [
{
"adjustments": 0.1,
"carriedOver": 0.1,
"notes": "string",
"totalDays": 0.1,
"usedDays": 0.1,
"year": 0
}
],
"workSchedule": {
"entries": [
{
"dayOfWeek": "MONDAY",
"isWorkDay": true,
"slots": [
{
"endTime": "string",
"startTime": "string"
}
],
"workDay": true
}
]
}
}
],
"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 team stats
AuthorizationBearer <token>
In: header
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/hr/employees/stats"{
"property1": 0,
"property2": 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 enriched employee
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/employees/string"{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"attachments": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"avatar": "string",
"contracts": [
{
"attachments": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"currency": "string",
"endDate": "2019-08-24",
"hours": 0.1,
"hoursType": "WEEKLY",
"id": "string",
"maxHours": 0.1,
"notes": "string",
"salary": 0.1,
"salaryType": "HOURLY",
"startDate": "2019-08-24",
"type": "PERMANENT"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"department": "string",
"email": "string",
"endDate": "2019-08-24",
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"firstName": "string",
"fullName": "string",
"githubUsername": "string",
"hourSettings": {
"currency": "string",
"hourlyRate": 0.1,
"requireTaskLink": true,
"trackingStartDate": "2019-08-24",
"weeklyHourTarget": 0.1
},
"id": "string",
"jobTitle": "string",
"lastName": "string",
"linkedinUrl": "string",
"manager": {
"avatar": "string",
"department": "string",
"email": "string",
"fullName": "string",
"id": "string",
"jobTitle": "string"
},
"managerId": "string",
"phone": "string",
"startDate": "2019-08-24",
"status": "ACTIVE",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"user": {
"displayName": "string",
"id": "string",
"username": "string"
},
"userId": "string",
"vacationBalances": [
{
"adjustments": 0.1,
"carriedOver": 0.1,
"notes": "string",
"totalDays": 0.1,
"usedDays": 0.1,
"year": 0
}
],
"workSchedule": {
"entries": [
{
"dayOfWeek": "MONDAY",
"isWorkDay": true,
"slots": [
{
"endTime": "string",
"startTime": "string"
}
],
"workDay": true
}
]
}
}{
"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 an employee
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/employees/string" \ -H "Content-Type: application/json" \ -d '{ "email": "string", "firstName": "string", "lastName": "string", "status": "ACTIVE" }'{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"attachments": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"avatar": "string",
"contracts": [
{
"attachments": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"currency": "string",
"endDate": "2019-08-24",
"hours": 0.1,
"hoursType": "WEEKLY",
"id": "string",
"maxHours": 0.1,
"notes": "string",
"salary": 0.1,
"salaryType": "HOURLY",
"startDate": "2019-08-24",
"type": "PERMANENT"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"department": "string",
"email": "string",
"endDate": "2019-08-24",
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"firstName": "string",
"fullName": "string",
"githubUsername": "string",
"hourSettings": {
"currency": "string",
"hourlyRate": 0.1,
"requireTaskLink": true,
"trackingStartDate": "2019-08-24",
"weeklyHourTarget": 0.1
},
"id": "string",
"jobTitle": "string",
"lastName": "string",
"linkedinUrl": "string",
"manager": {
"avatar": "string",
"department": "string",
"email": "string",
"fullName": "string",
"id": "string",
"jobTitle": "string"
},
"managerId": "string",
"phone": "string",
"startDate": "2019-08-24",
"status": "ACTIVE",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"user": {
"displayName": "string",
"id": "string",
"username": "string"
},
"userId": "string",
"vacationBalances": [
{
"adjustments": 0.1,
"carriedOver": 0.1,
"notes": "string",
"totalDays": 0.1,
"usedDays": 0.1,
"year": 0
}
],
"workSchedule": {
"entries": [
{
"dayOfWeek": "MONDAY",
"isWorkDay": true,
"slots": [
{
"endTime": "string",
"startTime": "string"
}
],
"workDay": true
}
]
}
}{
"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
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/employees/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"
}Upload attachments
AuthorizationBearer <token>
In: header
Path Parameters
id*string
Query Parameters
files*array<>
Response Body
application/json
application/json
application/json
application/json
curl -X POST "http://localhost:18080/api/v1/hr/employees/string/attachments?files=string"{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"attachments": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"avatar": "string",
"contracts": [
{
"attachments": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"currency": "string",
"endDate": "2019-08-24",
"hours": 0.1,
"hoursType": "WEEKLY",
"id": "string",
"maxHours": 0.1,
"notes": "string",
"salary": 0.1,
"salaryType": "HOURLY",
"startDate": "2019-08-24",
"type": "PERMANENT"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"department": "string",
"email": "string",
"endDate": "2019-08-24",
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"firstName": "string",
"fullName": "string",
"githubUsername": "string",
"hourSettings": {
"currency": "string",
"hourlyRate": 0.1,
"requireTaskLink": true,
"trackingStartDate": "2019-08-24",
"weeklyHourTarget": 0.1
},
"id": "string",
"jobTitle": "string",
"lastName": "string",
"linkedinUrl": "string",
"manager": {
"avatar": "string",
"department": "string",
"email": "string",
"fullName": "string",
"id": "string",
"jobTitle": "string"
},
"managerId": "string",
"phone": "string",
"startDate": "2019-08-24",
"status": "ACTIVE",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"user": {
"displayName": "string",
"id": "string",
"username": "string"
},
"userId": "string",
"vacationBalances": [
{
"adjustments": 0.1,
"carriedOver": 0.1,
"notes": "string",
"totalDays": 0.1,
"usedDays": 0.1,
"year": 0
}
],
"workSchedule": {
"entries": [
{
"dayOfWeek": "MONDAY",
"isWorkDay": true,
"slots": [
{
"endTime": "string",
"startTime": "string"
}
],
"workDay": true
}
]
}
}{
"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 attachment
AuthorizationBearer <token>
In: header
Path Parameters
id*string
blobId*string
Response Body
application/json
application/json
application/json
application/json
curl -X DELETE "http://localhost:18080/api/v1/hr/employees/string/attachments/string"{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"attachments": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"avatar": "string",
"contracts": [
{
"attachments": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"currency": "string",
"endDate": "2019-08-24",
"hours": 0.1,
"hoursType": "WEEKLY",
"id": "string",
"maxHours": 0.1,
"notes": "string",
"salary": 0.1,
"salaryType": "HOURLY",
"startDate": "2019-08-24",
"type": "PERMANENT"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"department": "string",
"email": "string",
"endDate": "2019-08-24",
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"firstName": "string",
"fullName": "string",
"githubUsername": "string",
"hourSettings": {
"currency": "string",
"hourlyRate": 0.1,
"requireTaskLink": true,
"trackingStartDate": "2019-08-24",
"weeklyHourTarget": 0.1
},
"id": "string",
"jobTitle": "string",
"lastName": "string",
"linkedinUrl": "string",
"manager": {
"avatar": "string",
"department": "string",
"email": "string",
"fullName": "string",
"id": "string",
"jobTitle": "string"
},
"managerId": "string",
"phone": "string",
"startDate": "2019-08-24",
"status": "ACTIVE",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"user": {
"displayName": "string",
"id": "string",
"username": "string"
},
"userId": "string",
"vacationBalances": [
{
"adjustments": 0.1,
"carriedOver": 0.1,
"notes": "string",
"totalDays": 0.1,
"usedDays": 0.1,
"year": 0
}
],
"workSchedule": {
"entries": [
{
"dayOfWeek": "MONDAY",
"isWorkDay": true,
"slots": [
{
"endTime": "string",
"startTime": "string"
}
],
"workDay": true
}
]
}
}{
"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
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/employees/string/comment" \ -H "Content-Type: application/json" \ -d 'string'{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"attachments": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"avatar": "string",
"contracts": [
{
"attachments": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"currency": "string",
"endDate": "2019-08-24",
"hours": 0.1,
"hoursType": "WEEKLY",
"id": "string",
"maxHours": 0.1,
"notes": "string",
"salary": 0.1,
"salaryType": "HOURLY",
"startDate": "2019-08-24",
"type": "PERMANENT"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"department": "string",
"email": "string",
"endDate": "2019-08-24",
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"firstName": "string",
"fullName": "string",
"githubUsername": "string",
"hourSettings": {
"currency": "string",
"hourlyRate": 0.1,
"requireTaskLink": true,
"trackingStartDate": "2019-08-24",
"weeklyHourTarget": 0.1
},
"id": "string",
"jobTitle": "string",
"lastName": "string",
"linkedinUrl": "string",
"manager": {
"avatar": "string",
"department": "string",
"email": "string",
"fullName": "string",
"id": "string",
"jobTitle": "string"
},
"managerId": "string",
"phone": "string",
"startDate": "2019-08-24",
"status": "ACTIVE",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"user": {
"displayName": "string",
"id": "string",
"username": "string"
},
"userId": "string",
"vacationBalances": [
{
"adjustments": 0.1,
"carriedOver": 0.1,
"notes": "string",
"totalDays": 0.1,
"usedDays": 0.1,
"year": 0
}
],
"workSchedule": {
"entries": [
{
"dayOfWeek": "MONDAY",
"isWorkDay": true,
"slots": [
{
"endTime": "string",
"startTime": "string"
}
],
"workDay": true
}
]
}
}{
"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 contract
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 POST "http://localhost:18080/api/v1/hr/employees/string/contracts" \ -H "Content-Type: application/json" \ -d '{ "currency": "string", "hoursType": "WEEKLY", "salaryType": "HOURLY", "startDate": "2019-08-24", "type": "PERMANENT" }'{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"attachments": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"avatar": "string",
"contracts": [
{
"attachments": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"currency": "string",
"endDate": "2019-08-24",
"hours": 0.1,
"hoursType": "WEEKLY",
"id": "string",
"maxHours": 0.1,
"notes": "string",
"salary": 0.1,
"salaryType": "HOURLY",
"startDate": "2019-08-24",
"type": "PERMANENT"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"department": "string",
"email": "string",
"endDate": "2019-08-24",
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"firstName": "string",
"fullName": "string",
"githubUsername": "string",
"hourSettings": {
"currency": "string",
"hourlyRate": 0.1,
"requireTaskLink": true,
"trackingStartDate": "2019-08-24",
"weeklyHourTarget": 0.1
},
"id": "string",
"jobTitle": "string",
"lastName": "string",
"linkedinUrl": "string",
"manager": {
"avatar": "string",
"department": "string",
"email": "string",
"fullName": "string",
"id": "string",
"jobTitle": "string"
},
"managerId": "string",
"phone": "string",
"startDate": "2019-08-24",
"status": "ACTIVE",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"user": {
"displayName": "string",
"id": "string",
"username": "string"
},
"userId": "string",
"vacationBalances": [
{
"adjustments": 0.1,
"carriedOver": 0.1,
"notes": "string",
"totalDays": 0.1,
"usedDays": 0.1,
"year": 0
}
],
"workSchedule": {
"entries": [
{
"dayOfWeek": "MONDAY",
"isWorkDay": true,
"slots": [
{
"endTime": "string",
"startTime": "string"
}
],
"workDay": true
}
]
}
}{
"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 contract
AuthorizationBearer <token>
In: header
Path Parameters
id*string
contractId*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/employees/string/contracts/string" \ -H "Content-Type: application/json" \ -d '{ "currency": "string", "hoursType": "WEEKLY", "salaryType": "HOURLY", "startDate": "2019-08-24", "type": "PERMANENT" }'{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"attachments": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"avatar": "string",
"contracts": [
{
"attachments": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"currency": "string",
"endDate": "2019-08-24",
"hours": 0.1,
"hoursType": "WEEKLY",
"id": "string",
"maxHours": 0.1,
"notes": "string",
"salary": 0.1,
"salaryType": "HOURLY",
"startDate": "2019-08-24",
"type": "PERMANENT"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"department": "string",
"email": "string",
"endDate": "2019-08-24",
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"firstName": "string",
"fullName": "string",
"githubUsername": "string",
"hourSettings": {
"currency": "string",
"hourlyRate": 0.1,
"requireTaskLink": true,
"trackingStartDate": "2019-08-24",
"weeklyHourTarget": 0.1
},
"id": "string",
"jobTitle": "string",
"lastName": "string",
"linkedinUrl": "string",
"manager": {
"avatar": "string",
"department": "string",
"email": "string",
"fullName": "string",
"id": "string",
"jobTitle": "string"
},
"managerId": "string",
"phone": "string",
"startDate": "2019-08-24",
"status": "ACTIVE",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"user": {
"displayName": "string",
"id": "string",
"username": "string"
},
"userId": "string",
"vacationBalances": [
{
"adjustments": 0.1,
"carriedOver": 0.1,
"notes": "string",
"totalDays": 0.1,
"usedDays": 0.1,
"year": 0
}
],
"workSchedule": {
"entries": [
{
"dayOfWeek": "MONDAY",
"isWorkDay": true,
"slots": [
{
"endTime": "string",
"startTime": "string"
}
],
"workDay": true
}
]
}
}{
"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 contract
AuthorizationBearer <token>
In: header
Path Parameters
id*string
contractId*string
Response Body
application/json
application/json
application/json
application/json
curl -X DELETE "http://localhost:18080/api/v1/hr/employees/string/contracts/string"{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"attachments": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"avatar": "string",
"contracts": [
{
"attachments": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"currency": "string",
"endDate": "2019-08-24",
"hours": 0.1,
"hoursType": "WEEKLY",
"id": "string",
"maxHours": 0.1,
"notes": "string",
"salary": 0.1,
"salaryType": "HOURLY",
"startDate": "2019-08-24",
"type": "PERMANENT"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"department": "string",
"email": "string",
"endDate": "2019-08-24",
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"firstName": "string",
"fullName": "string",
"githubUsername": "string",
"hourSettings": {
"currency": "string",
"hourlyRate": 0.1,
"requireTaskLink": true,
"trackingStartDate": "2019-08-24",
"weeklyHourTarget": 0.1
},
"id": "string",
"jobTitle": "string",
"lastName": "string",
"linkedinUrl": "string",
"manager": {
"avatar": "string",
"department": "string",
"email": "string",
"fullName": "string",
"id": "string",
"jobTitle": "string"
},
"managerId": "string",
"phone": "string",
"startDate": "2019-08-24",
"status": "ACTIVE",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"user": {
"displayName": "string",
"id": "string",
"username": "string"
},
"userId": "string",
"vacationBalances": [
{
"adjustments": 0.1,
"carriedOver": 0.1,
"notes": "string",
"totalDays": 0.1,
"usedDays": 0.1,
"year": 0
}
],
"workSchedule": {
"entries": [
{
"dayOfWeek": "MONDAY",
"isWorkDay": true,
"slots": [
{
"endTime": "string",
"startTime": "string"
}
],
"workDay": true
}
]
}
}{
"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"
}Upload contract attachments
AuthorizationBearer <token>
In: header
Path Parameters
id*string
contractId*string
Query Parameters
files*array<>
Response Body
application/json
application/json
application/json
application/json
curl -X POST "http://localhost:18080/api/v1/hr/employees/string/contracts/string/attachments?files=string"{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"attachments": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"avatar": "string",
"contracts": [
{
"attachments": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"currency": "string",
"endDate": "2019-08-24",
"hours": 0.1,
"hoursType": "WEEKLY",
"id": "string",
"maxHours": 0.1,
"notes": "string",
"salary": 0.1,
"salaryType": "HOURLY",
"startDate": "2019-08-24",
"type": "PERMANENT"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"department": "string",
"email": "string",
"endDate": "2019-08-24",
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"firstName": "string",
"fullName": "string",
"githubUsername": "string",
"hourSettings": {
"currency": "string",
"hourlyRate": 0.1,
"requireTaskLink": true,
"trackingStartDate": "2019-08-24",
"weeklyHourTarget": 0.1
},
"id": "string",
"jobTitle": "string",
"lastName": "string",
"linkedinUrl": "string",
"manager": {
"avatar": "string",
"department": "string",
"email": "string",
"fullName": "string",
"id": "string",
"jobTitle": "string"
},
"managerId": "string",
"phone": "string",
"startDate": "2019-08-24",
"status": "ACTIVE",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"user": {
"displayName": "string",
"id": "string",
"username": "string"
},
"userId": "string",
"vacationBalances": [
{
"adjustments": 0.1,
"carriedOver": 0.1,
"notes": "string",
"totalDays": 0.1,
"usedDays": 0.1,
"year": 0
}
],
"workSchedule": {
"entries": [
{
"dayOfWeek": "MONDAY",
"isWorkDay": true,
"slots": [
{
"endTime": "string",
"startTime": "string"
}
],
"workDay": true
}
]
}
}{
"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 contract attachment
AuthorizationBearer <token>
In: header
Path Parameters
id*string
contractId*string
blobId*string
Response Body
application/json
application/json
application/json
application/json
curl -X DELETE "http://localhost:18080/api/v1/hr/employees/string/contracts/string/attachments/string"{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"attachments": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"avatar": "string",
"contracts": [
{
"attachments": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"currency": "string",
"endDate": "2019-08-24",
"hours": 0.1,
"hoursType": "WEEKLY",
"id": "string",
"maxHours": 0.1,
"notes": "string",
"salary": 0.1,
"salaryType": "HOURLY",
"startDate": "2019-08-24",
"type": "PERMANENT"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"department": "string",
"email": "string",
"endDate": "2019-08-24",
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"firstName": "string",
"fullName": "string",
"githubUsername": "string",
"hourSettings": {
"currency": "string",
"hourlyRate": 0.1,
"requireTaskLink": true,
"trackingStartDate": "2019-08-24",
"weeklyHourTarget": 0.1
},
"id": "string",
"jobTitle": "string",
"lastName": "string",
"linkedinUrl": "string",
"manager": {
"avatar": "string",
"department": "string",
"email": "string",
"fullName": "string",
"id": "string",
"jobTitle": "string"
},
"managerId": "string",
"phone": "string",
"startDate": "2019-08-24",
"status": "ACTIVE",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"user": {
"displayName": "string",
"id": "string",
"username": "string"
},
"userId": "string",
"vacationBalances": [
{
"adjustments": 0.1,
"carriedOver": 0.1,
"notes": "string",
"totalDays": 0.1,
"usedDays": 0.1,
"year": 0
}
],
"workSchedule": {
"entries": [
{
"dayOfWeek": "MONDAY",
"isWorkDay": true,
"slots": [
{
"endTime": "string",
"startTime": "string"
}
],
"workDay": true
}
]
}
}{
"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 hour settings
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/employees/string/hour-settings" \ -H "Content-Type: application/json" \ -d '{ "requireTaskLink": true, "weeklyHourTarget": 0.1 }'{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"attachments": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"avatar": "string",
"contracts": [
{
"attachments": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"currency": "string",
"endDate": "2019-08-24",
"hours": 0.1,
"hoursType": "WEEKLY",
"id": "string",
"maxHours": 0.1,
"notes": "string",
"salary": 0.1,
"salaryType": "HOURLY",
"startDate": "2019-08-24",
"type": "PERMANENT"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"department": "string",
"email": "string",
"endDate": "2019-08-24",
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"firstName": "string",
"fullName": "string",
"githubUsername": "string",
"hourSettings": {
"currency": "string",
"hourlyRate": 0.1,
"requireTaskLink": true,
"trackingStartDate": "2019-08-24",
"weeklyHourTarget": 0.1
},
"id": "string",
"jobTitle": "string",
"lastName": "string",
"linkedinUrl": "string",
"manager": {
"avatar": "string",
"department": "string",
"email": "string",
"fullName": "string",
"id": "string",
"jobTitle": "string"
},
"managerId": "string",
"phone": "string",
"startDate": "2019-08-24",
"status": "ACTIVE",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"user": {
"displayName": "string",
"id": "string",
"username": "string"
},
"userId": "string",
"vacationBalances": [
{
"adjustments": 0.1,
"carriedOver": 0.1,
"notes": "string",
"totalDays": 0.1,
"usedDays": 0.1,
"year": 0
}
],
"workSchedule": {
"entries": [
{
"dayOfWeek": "MONDAY",
"isWorkDay": true,
"slots": [
{
"endTime": "string",
"startTime": "string"
}
],
"workDay": true
}
]
}
}{
"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"
}Link user to employee
AuthorizationBearer <token>
In: header
Path Parameters
id*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
userId*string
Response Body
application/json
application/json
application/json
application/json
curl -X POST "http://localhost:18080/api/v1/hr/employees/string/link-user" \ -H "Content-Type: application/json" \ -d '{ "userId": "string" }'{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"attachments": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"avatar": "string",
"contracts": [
{
"attachments": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"currency": "string",
"endDate": "2019-08-24",
"hours": 0.1,
"hoursType": "WEEKLY",
"id": "string",
"maxHours": 0.1,
"notes": "string",
"salary": 0.1,
"salaryType": "HOURLY",
"startDate": "2019-08-24",
"type": "PERMANENT"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"department": "string",
"email": "string",
"endDate": "2019-08-24",
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"firstName": "string",
"fullName": "string",
"githubUsername": "string",
"hourSettings": {
"currency": "string",
"hourlyRate": 0.1,
"requireTaskLink": true,
"trackingStartDate": "2019-08-24",
"weeklyHourTarget": 0.1
},
"id": "string",
"jobTitle": "string",
"lastName": "string",
"linkedinUrl": "string",
"manager": {
"avatar": "string",
"department": "string",
"email": "string",
"fullName": "string",
"id": "string",
"jobTitle": "string"
},
"managerId": "string",
"phone": "string",
"startDate": "2019-08-24",
"status": "ACTIVE",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"user": {
"displayName": "string",
"id": "string",
"username": "string"
},
"userId": "string",
"vacationBalances": [
{
"adjustments": 0.1,
"carriedOver": 0.1,
"notes": "string",
"totalDays": 0.1,
"usedDays": 0.1,
"year": 0
}
],
"workSchedule": {
"entries": [
{
"dayOfWeek": "MONDAY",
"isWorkDay": true,
"slots": [
{
"endTime": "string",
"startTime": "string"
}
],
"workDay": true
}
]
}
}{
"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"
}Unlink user from employee
AuthorizationBearer <token>
In: header
Path Parameters
id*string
Response Body
application/json
application/json
application/json
application/json
curl -X DELETE "http://localhost:18080/api/v1/hr/employees/string/link-user"{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"attachments": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"avatar": "string",
"contracts": [
{
"attachments": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"currency": "string",
"endDate": "2019-08-24",
"hours": 0.1,
"hoursType": "WEEKLY",
"id": "string",
"maxHours": 0.1,
"notes": "string",
"salary": 0.1,
"salaryType": "HOURLY",
"startDate": "2019-08-24",
"type": "PERMANENT"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"department": "string",
"email": "string",
"endDate": "2019-08-24",
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"firstName": "string",
"fullName": "string",
"githubUsername": "string",
"hourSettings": {
"currency": "string",
"hourlyRate": 0.1,
"requireTaskLink": true,
"trackingStartDate": "2019-08-24",
"weeklyHourTarget": 0.1
},
"id": "string",
"jobTitle": "string",
"lastName": "string",
"linkedinUrl": "string",
"manager": {
"avatar": "string",
"department": "string",
"email": "string",
"fullName": "string",
"id": "string",
"jobTitle": "string"
},
"managerId": "string",
"phone": "string",
"startDate": "2019-08-24",
"status": "ACTIVE",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"user": {
"displayName": "string",
"id": "string",
"username": "string"
},
"userId": "string",
"vacationBalances": [
{
"adjustments": 0.1,
"carriedOver": 0.1,
"notes": "string",
"totalDays": 0.1,
"usedDays": 0.1,
"year": 0
}
],
"workSchedule": {
"entries": [
{
"dayOfWeek": "MONDAY",
"isWorkDay": true,
"slots": [
{
"endTime": "string",
"startTime": "string"
}
],
"workDay": true
}
]
}
}{
"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 employee status
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/employees/string/status" \ -H "Content-Type: application/json" \ -d '{ "status": "ACTIVE" }'{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"attachments": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"avatar": "string",
"contracts": [
{
"attachments": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"currency": "string",
"endDate": "2019-08-24",
"hours": 0.1,
"hoursType": "WEEKLY",
"id": "string",
"maxHours": 0.1,
"notes": "string",
"salary": 0.1,
"salaryType": "HOURLY",
"startDate": "2019-08-24",
"type": "PERMANENT"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"department": "string",
"email": "string",
"endDate": "2019-08-24",
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"firstName": "string",
"fullName": "string",
"githubUsername": "string",
"hourSettings": {
"currency": "string",
"hourlyRate": 0.1,
"requireTaskLink": true,
"trackingStartDate": "2019-08-24",
"weeklyHourTarget": 0.1
},
"id": "string",
"jobTitle": "string",
"lastName": "string",
"linkedinUrl": "string",
"manager": {
"avatar": "string",
"department": "string",
"email": "string",
"fullName": "string",
"id": "string",
"jobTitle": "string"
},
"managerId": "string",
"phone": "string",
"startDate": "2019-08-24",
"status": "ACTIVE",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"user": {
"displayName": "string",
"id": "string",
"username": "string"
},
"userId": "string",
"vacationBalances": [
{
"adjustments": 0.1,
"carriedOver": 0.1,
"notes": "string",
"totalDays": 0.1,
"usedDays": 0.1,
"year": 0
}
],
"workSchedule": {
"entries": [
{
"dayOfWeek": "MONDAY",
"isWorkDay": true,
"slots": [
{
"endTime": "string",
"startTime": "string"
}
],
"workDay": true
}
]
}
}{
"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"
}Set vacation balance
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 POST "http://localhost:18080/api/v1/hr/employees/string/vacation-balance" \ -H "Content-Type: application/json" \ -d '{ "adjustments": 0.1, "carriedOver": 0.1, "totalDays": 0.1, "year": 0 }'{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"attachments": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"avatar": "string",
"contracts": [
{
"attachments": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"currency": "string",
"endDate": "2019-08-24",
"hours": 0.1,
"hoursType": "WEEKLY",
"id": "string",
"maxHours": 0.1,
"notes": "string",
"salary": 0.1,
"salaryType": "HOURLY",
"startDate": "2019-08-24",
"type": "PERMANENT"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"department": "string",
"email": "string",
"endDate": "2019-08-24",
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"firstName": "string",
"fullName": "string",
"githubUsername": "string",
"hourSettings": {
"currency": "string",
"hourlyRate": 0.1,
"requireTaskLink": true,
"trackingStartDate": "2019-08-24",
"weeklyHourTarget": 0.1
},
"id": "string",
"jobTitle": "string",
"lastName": "string",
"linkedinUrl": "string",
"manager": {
"avatar": "string",
"department": "string",
"email": "string",
"fullName": "string",
"id": "string",
"jobTitle": "string"
},
"managerId": "string",
"phone": "string",
"startDate": "2019-08-24",
"status": "ACTIVE",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"user": {
"displayName": "string",
"id": "string",
"username": "string"
},
"userId": "string",
"vacationBalances": [
{
"adjustments": 0.1,
"carriedOver": 0.1,
"notes": "string",
"totalDays": 0.1,
"usedDays": 0.1,
"year": 0
}
],
"workSchedule": {
"entries": [
{
"dayOfWeek": "MONDAY",
"isWorkDay": true,
"slots": [
{
"endTime": "string",
"startTime": "string"
}
],
"workDay": true
}
]
}
}{
"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 work schedule
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/employees/string/work-schedule" \ -H "Content-Type: application/json" \ -d '{ "entries": [ { "dayOfWeek": "MONDAY", "isWorkDay": true, "slots": [ { "availableCount": 0, "endTime": "2019-08-24T14:15:22Z", "startTime": "2019-08-24T14:15:22Z" } ] } ] }'{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"attachments": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"avatar": "string",
"contracts": [
{
"attachments": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"currency": "string",
"endDate": "2019-08-24",
"hours": 0.1,
"hoursType": "WEEKLY",
"id": "string",
"maxHours": 0.1,
"notes": "string",
"salary": 0.1,
"salaryType": "HOURLY",
"startDate": "2019-08-24",
"type": "PERMANENT"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"department": "string",
"email": "string",
"endDate": "2019-08-24",
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"firstName": "string",
"fullName": "string",
"githubUsername": "string",
"hourSettings": {
"currency": "string",
"hourlyRate": 0.1,
"requireTaskLink": true,
"trackingStartDate": "2019-08-24",
"weeklyHourTarget": 0.1
},
"id": "string",
"jobTitle": "string",
"lastName": "string",
"linkedinUrl": "string",
"manager": {
"avatar": "string",
"department": "string",
"email": "string",
"fullName": "string",
"id": "string",
"jobTitle": "string"
},
"managerId": "string",
"phone": "string",
"startDate": "2019-08-24",
"status": "ACTIVE",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"user": {
"displayName": "string",
"id": "string",
"username": "string"
},
"userId": "string",
"vacationBalances": [
{
"adjustments": 0.1,
"carriedOver": 0.1,
"notes": "string",
"totalDays": 0.1,
"usedDays": 0.1,
"year": 0
}
],
"workSchedule": {
"entries": [
{
"dayOfWeek": "MONDAY",
"isWorkDay": true,
"slots": [
{
"endTime": "string",
"startTime": "string"
}
],
"workDay": true
}
]
}
}{
"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"
}