AlphaAlpha Docs
API Reference

H R Project

API calls for HR projects (epics/tasks organization)

Create a project

POST
/hr/projects

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/projects" \  -H "Content-Type: application/json" \  -d '{    "code": "string",    "defaultSprintDurationDays": 0,    "name": "string",    "status": "PLANNING",    "tags": [      "string"    ],    "teamMemberIds": [      "string"    ]  }'
{
  "clientId": "string",
  "code": "string",
  "color": "string",
  "completedTaskCount": 0,
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "defaultSprintDurationDays": 0,
  "description": "string",
  "endDate": "2019-08-24",
  "epicCount": 0,
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "hourlyRate": 0.1,
  "id": "string",
  "lead": {
    "avatar": "string",
    "department": "string",
    "email": "string",
    "fullName": "string",
    "id": "string",
    "jobTitle": "string"
  },
  "leadId": "string",
  "name": "string",
  "picture": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "progress": 0.1,
  "startDate": "2019-08-24",
  "status": "PLANNING",
  "tags": [
    "string"
  ],
  "taskCount": 0,
  "teamMemberIds": [
    "string"
  ],
  "teamMembers": [
    {
      "avatar": "string",
      "department": "string",
      "email": "string",
      "fullName": "string",
      "id": "string",
      "jobTitle": "string"
    }
  ],
  "tenantId": "string",
  "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 active projects

GET
/hr/projects/active

Authorization

AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/hr/projects/active"
[
  {
    "clientId": "string",
    "code": "string",
    "color": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "defaultSprintDurationDays": 0,
    "description": "string",
    "endDate": "2019-08-24",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "hourlyRate": 0.1,
    "id": "string",
    "leadId": "string",
    "name": "string",
    "picture": {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    },
    "startDate": "2019-08-24",
    "status": "PLANNING",
    "tags": [
      "string"
    ],
    "teamMemberIds": [
      "string"
    ],
    "tenantId": "string",
    "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 projects by lead

GET
/hr/projects/by-lead/{leadId}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

leadId*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/hr/projects/by-lead/string"
[
  {
    "clientId": "string",
    "code": "string",
    "color": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "defaultSprintDurationDays": 0,
    "description": "string",
    "endDate": "2019-08-24",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "hourlyRate": 0.1,
    "id": "string",
    "leadId": "string",
    "name": "string",
    "picture": {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    },
    "startDate": "2019-08-24",
    "status": "PLANNING",
    "tags": [
      "string"
    ],
    "teamMemberIds": [
      "string"
    ],
    "tenantId": "string",
    "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 projects by status

GET
/hr/projects/by-status/{status}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

status*string
Value in"PLANNING" | "ACTIVE" | "ON_HOLD" | "COMPLETED" | "ARCHIVED"

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/hr/projects/by-status/PLANNING"
[
  {
    "clientId": "string",
    "code": "string",
    "color": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "defaultSprintDurationDays": 0,
    "description": "string",
    "endDate": "2019-08-24",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "hourlyRate": 0.1,
    "id": "string",
    "leadId": "string",
    "name": "string",
    "picture": {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    },
    "startDate": "2019-08-24",
    "status": "PLANNING",
    "tags": [
      "string"
    ],
    "teamMemberIds": [
      "string"
    ],
    "tenantId": "string",
    "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_ Hr Project

GET
/hr/projects/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/projects/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/projects/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/projects/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_ Hr Project

GET
/hr/projects/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/projects/dynamic-search"
{
  "content": [
    {
      "clientId": "string",
      "code": "string",
      "color": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "defaultSprintDurationDays": 0,
      "description": "string",
      "endDate": "2019-08-24",
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "hourlyRate": 0.1,
      "id": "string",
      "leadId": "string",
      "name": "string",
      "picture": {
        "blobId": "string",
        "created": "2019-08-24T14:15:22Z",
        "extension": "string",
        "fileSize": 0,
        "name": "string",
        "type": "IMAGE"
      },
      "startDate": "2019-08-24",
      "status": "PLANNING",
      "tags": [
        "string"
      ],
      "teamMemberIds": [
        "string"
      ],
      "tenantId": "string",
      "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_ Hr Project

POST
/hr/projects/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/projects/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": [
    {
      "clientId": "string",
      "code": "string",
      "color": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "defaultSprintDurationDays": 0,
      "description": "string",
      "endDate": "2019-08-24",
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "hourlyRate": 0.1,
      "id": "string",
      "leadId": "string",
      "name": "string",
      "picture": {
        "blobId": "string",
        "created": "2019-08-24T14:15:22Z",
        "extension": "string",
        "fileSize": 0,
        "name": "string",
        "type": "IMAGE"
      },
      "startDate": "2019-08-24",
      "status": "PLANNING",
      "tags": [
        "string"
      ],
      "teamMemberIds": [
        "string"
      ],
      "tenantId": "string",
      "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/projects/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/projects/find?ids=string"
[
  {
    "clientId": "string",
    "code": "string",
    "color": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "defaultSprintDurationDays": 0,
    "description": "string",
    "endDate": "2019-08-24",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "hourlyRate": 0.1,
    "id": "string",
    "leadId": "string",
    "name": "string",
    "picture": {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    },
    "startDate": "2019-08-24",
    "status": "PLANNING",
    "tags": [
      "string"
    ],
    "teamMemberIds": [
      "string"
    ],
    "tenantId": "string",
    "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/projects/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/projects/find-all"
[
  {
    "clientId": "string",
    "code": "string",
    "color": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "defaultSprintDurationDays": 0,
    "description": "string",
    "endDate": "2019-08-24",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "hourlyRate": 0.1,
    "id": "string",
    "leadId": "string",
    "name": "string",
    "picture": {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    },
    "startDate": "2019-08-24",
    "status": "PLANNING",
    "tags": [
      "string"
    ],
    "teamMemberIds": [
      "string"
    ],
    "tenantId": "string",
    "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/projects/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/projects/find-list"
[
  {
    "clientId": "string",
    "code": "string",
    "color": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "defaultSprintDurationDays": 0,
    "description": "string",
    "endDate": "2019-08-24",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "hourlyRate": 0.1,
    "id": "string",
    "leadId": "string",
    "name": "string",
    "picture": {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    },
    "startDate": "2019-08-24",
    "status": "PLANNING",
    "tags": [
      "string"
    ],
    "teamMemberIds": [
      "string"
    ],
    "tenantId": "string",
    "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/projects/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/projects/find/string"
{
  "clientId": "string",
  "code": "string",
  "color": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "defaultSprintDurationDays": 0,
  "description": "string",
  "endDate": "2019-08-24",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "hourlyRate": 0.1,
  "id": "string",
  "leadId": "string",
  "name": "string",
  "picture": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "startDate": "2019-08-24",
  "status": "PLANNING",
  "tags": [
    "string"
  ],
  "teamMemberIds": [
    "string"
  ],
  "tenantId": "string",
  "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 projects

GET
/hr/projects/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/projects/page"
{
  "content": [
    {
      "clientId": "string",
      "code": "string",
      "color": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "defaultSprintDurationDays": 0,
      "description": "string",
      "endDate": "2019-08-24",
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "hourlyRate": 0.1,
      "id": "string",
      "leadId": "string",
      "name": "string",
      "picture": {
        "blobId": "string",
        "created": "2019-08-24T14:15:22Z",
        "extension": "string",
        "fileSize": 0,
        "name": "string",
        "type": "IMAGE"
      },
      "startDate": "2019-08-24",
      "status": "PLANNING",
      "tags": [
        "string"
      ],
      "teamMemberIds": [
        "string"
      ],
      "tenantId": "string",
      "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 enriched project

GET
/hr/projects/{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/projects/string"
{
  "clientId": "string",
  "code": "string",
  "color": "string",
  "completedTaskCount": 0,
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "defaultSprintDurationDays": 0,
  "description": "string",
  "endDate": "2019-08-24",
  "epicCount": 0,
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "hourlyRate": 0.1,
  "id": "string",
  "lead": {
    "avatar": "string",
    "department": "string",
    "email": "string",
    "fullName": "string",
    "id": "string",
    "jobTitle": "string"
  },
  "leadId": "string",
  "name": "string",
  "picture": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "progress": 0.1,
  "startDate": "2019-08-24",
  "status": "PLANNING",
  "tags": [
    "string"
  ],
  "taskCount": 0,
  "teamMemberIds": [
    "string"
  ],
  "teamMembers": [
    {
      "avatar": "string",
      "department": "string",
      "email": "string",
      "fullName": "string",
      "id": "string",
      "jobTitle": "string"
    }
  ],
  "tenantId": "string",
  "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 project

PATCH
/hr/projects/{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/projects/string" \  -H "Content-Type: application/json" \  -d '{    "code": "string",    "defaultSprintDurationDays": 0,    "name": "string",    "status": "PLANNING",    "tags": [      "string"    ],    "teamMemberIds": [      "string"    ]  }'
{
  "clientId": "string",
  "code": "string",
  "color": "string",
  "completedTaskCount": 0,
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "defaultSprintDurationDays": 0,
  "description": "string",
  "endDate": "2019-08-24",
  "epicCount": 0,
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "hourlyRate": 0.1,
  "id": "string",
  "lead": {
    "avatar": "string",
    "department": "string",
    "email": "string",
    "fullName": "string",
    "id": "string",
    "jobTitle": "string"
  },
  "leadId": "string",
  "name": "string",
  "picture": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "progress": 0.1,
  "startDate": "2019-08-24",
  "status": "PLANNING",
  "tags": [
    "string"
  ],
  "taskCount": 0,
  "teamMemberIds": [
    "string"
  ],
  "teamMembers": [
    {
      "avatar": "string",
      "department": "string",
      "email": "string",
      "fullName": "string",
      "id": "string",
      "jobTitle": "string"
    }
  ],
  "tenantId": "string",
  "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/projects/{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/projects/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"
}

Add a comment to an entity

POST
/hr/projects/{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/projects/string/comment" \  -H "Content-Type: application/json" \  -d 'string'
{
  "clientId": "string",
  "code": "string",
  "color": "string",
  "completedTaskCount": 0,
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "defaultSprintDurationDays": 0,
  "description": "string",
  "endDate": "2019-08-24",
  "epicCount": 0,
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "hourlyRate": 0.1,
  "id": "string",
  "lead": {
    "avatar": "string",
    "department": "string",
    "email": "string",
    "fullName": "string",
    "id": "string",
    "jobTitle": "string"
  },
  "leadId": "string",
  "name": "string",
  "picture": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "progress": 0.1,
  "startDate": "2019-08-24",
  "status": "PLANNING",
  "tags": [
    "string"
  ],
  "taskCount": 0,
  "teamMemberIds": [
    "string"
  ],
  "teamMembers": [
    {
      "avatar": "string",
      "department": "string",
      "email": "string",
      "fullName": "string",
      "id": "string",
      "jobTitle": "string"
    }
  ],
  "tenantId": "string",
  "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"
}

Upload project picture

POST
/hr/projects/{id}/picture

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 POST "http://localhost:18080/api/v1/hr/projects/string/picture" \  -H "Content-Type: application/json" \  -d '{    "file": "string"  }'
{
  "clientId": "string",
  "code": "string",
  "color": "string",
  "completedTaskCount": 0,
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "defaultSprintDurationDays": 0,
  "description": "string",
  "endDate": "2019-08-24",
  "epicCount": 0,
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "hourlyRate": 0.1,
  "id": "string",
  "lead": {
    "avatar": "string",
    "department": "string",
    "email": "string",
    "fullName": "string",
    "id": "string",
    "jobTitle": "string"
  },
  "leadId": "string",
  "name": "string",
  "picture": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "progress": 0.1,
  "startDate": "2019-08-24",
  "status": "PLANNING",
  "tags": [
    "string"
  ],
  "taskCount": 0,
  "teamMemberIds": [
    "string"
  ],
  "teamMembers": [
    {
      "avatar": "string",
      "department": "string",
      "email": "string",
      "fullName": "string",
      "id": "string",
      "jobTitle": "string"
    }
  ],
  "tenantId": "string",
  "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 project picture

DELETE
/hr/projects/{id}/picture

Authorization

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/projects/string/picture"
{
  "clientId": "string",
  "code": "string",
  "color": "string",
  "completedTaskCount": 0,
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "defaultSprintDurationDays": 0,
  "description": "string",
  "endDate": "2019-08-24",
  "epicCount": 0,
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "hourlyRate": 0.1,
  "id": "string",
  "lead": {
    "avatar": "string",
    "department": "string",
    "email": "string",
    "fullName": "string",
    "id": "string",
    "jobTitle": "string"
  },
  "leadId": "string",
  "name": "string",
  "picture": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "progress": 0.1,
  "startDate": "2019-08-24",
  "status": "PLANNING",
  "tags": [
    "string"
  ],
  "taskCount": 0,
  "teamMemberIds": [
    "string"
  ],
  "teamMembers": [
    {
      "avatar": "string",
      "department": "string",
      "email": "string",
      "fullName": "string",
      "id": "string",
      "jobTitle": "string"
    }
  ],
  "tenantId": "string",
  "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 project status

PATCH
/hr/projects/{id}/status

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/projects/string/status" \  -H "Content-Type: application/json" \  -d '{    "status": "PLANNING"  }'
{
  "clientId": "string",
  "code": "string",
  "color": "string",
  "completedTaskCount": 0,
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "defaultSprintDurationDays": 0,
  "description": "string",
  "endDate": "2019-08-24",
  "epicCount": 0,
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "hourlyRate": 0.1,
  "id": "string",
  "lead": {
    "avatar": "string",
    "department": "string",
    "email": "string",
    "fullName": "string",
    "id": "string",
    "jobTitle": "string"
  },
  "leadId": "string",
  "name": "string",
  "picture": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "progress": 0.1,
  "startDate": "2019-08-24",
  "status": "PLANNING",
  "tags": [
    "string"
  ],
  "taskCount": 0,
  "teamMemberIds": [
    "string"
  ],
  "teamMembers": [
    {
      "avatar": "string",
      "department": "string",
      "email": "string",
      "fullName": "string",
      "id": "string",
      "jobTitle": "string"
    }
  ],
  "tenantId": "string",
  "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 Leave Request

Previous Page

H R Release

Next Page