AlphaAlpha Docs
API Reference

H R Task

API calls for HR tasks

Create a task

POST
/hr/tasks

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/tasks" \  -H "Content-Type: application/json" \  -d '{    "labels": [      "string"    ],    "links": [      {        "url": "string"      }    ],    "name": "string",    "priority": "LOW",    "status": "TODO",    "taskType": "TASK"  }'
{
  "assignee": {
    "avatar": "string",
    "department": "string",
    "email": "string",
    "fullName": "string",
    "id": "string",
    "jobTitle": "string"
  },
  "assigneeId": "string",
  "clientRef": "string",
  "completedAt": "2019-08-24T14:15:22Z",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "description": "string",
  "dueDate": "2019-08-24",
  "epic": {
    "color": "string",
    "id": "string",
    "name": "string"
  },
  "epicId": "string",
  "estimatedHours": 0.1,
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "feature": {
    "id": "string",
    "name": "string"
  },
  "featureId": "string",
  "id": "string",
  "labels": [
    "string"
  ],
  "links": [
    {
      "label": "string",
      "url": "string"
    }
  ],
  "name": "string",
  "priority": "LOW",
  "project": {
    "id": "string",
    "name": "string"
  },
  "sprint": {
    "id": "string",
    "name": "string"
  },
  "sprintId": "string",
  "status": "TODO",
  "storyPoints": 0,
  "taskType": "TASK",
  "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 backlog

GET
/hr/tasks/backlog

Authorization

AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/hr/tasks/backlog"
[
  {
    "assigneeId": "string",
    "clientRef": "string",
    "completedAt": "2019-08-24T14:15:22Z",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "description": "string",
    "dueDate": "2019-08-24",
    "epicId": "string",
    "estimatedHours": 0.1,
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "featureId": "string",
    "id": "string",
    "labels": [
      "string"
    ],
    "links": [
      {
        "label": "string",
        "url": "string"
      }
    ],
    "name": "string",
    "priority": "LOW",
    "sprintId": "string",
    "status": "TODO",
    "storyPoints": 0,
    "taskType": "TASK",
    "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 tasks by assignee

GET
/hr/tasks/by-assignee/{assigneeId}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

assigneeId*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/hr/tasks/by-assignee/string"
[
  {
    "assigneeId": "string",
    "clientRef": "string",
    "completedAt": "2019-08-24T14:15:22Z",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "description": "string",
    "dueDate": "2019-08-24",
    "epicId": "string",
    "estimatedHours": 0.1,
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "featureId": "string",
    "id": "string",
    "labels": [
      "string"
    ],
    "links": [
      {
        "label": "string",
        "url": "string"
      }
    ],
    "name": "string",
    "priority": "LOW",
    "sprintId": "string",
    "status": "TODO",
    "storyPoints": 0,
    "taskType": "TASK",
    "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 tasks by epic

GET
/hr/tasks/by-epic/{epicId}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

epicId*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/hr/tasks/by-epic/string"
[
  {
    "assigneeId": "string",
    "clientRef": "string",
    "completedAt": "2019-08-24T14:15:22Z",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "description": "string",
    "dueDate": "2019-08-24",
    "epicId": "string",
    "estimatedHours": 0.1,
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "featureId": "string",
    "id": "string",
    "labels": [
      "string"
    ],
    "links": [
      {
        "label": "string",
        "url": "string"
      }
    ],
    "name": "string",
    "priority": "LOW",
    "sprintId": "string",
    "status": "TODO",
    "storyPoints": 0,
    "taskType": "TASK",
    "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 tasks by feature

GET
/hr/tasks/by-feature/{featureId}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

featureId*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/hr/tasks/by-feature/string"
[
  {
    "assigneeId": "string",
    "clientRef": "string",
    "completedAt": "2019-08-24T14:15:22Z",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "description": "string",
    "dueDate": "2019-08-24",
    "epicId": "string",
    "estimatedHours": 0.1,
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "featureId": "string",
    "id": "string",
    "labels": [
      "string"
    ],
    "links": [
      {
        "label": "string",
        "url": "string"
      }
    ],
    "name": "string",
    "priority": "LOW",
    "sprintId": "string",
    "status": "TODO",
    "storyPoints": 0,
    "taskType": "TASK",
    "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 tasks by project

GET
/hr/tasks/by-project/{projectId}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

projectId*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/hr/tasks/by-project/string"
[
  {
    "assignee": {
      "avatar": "string",
      "department": "string",
      "email": "string",
      "fullName": "string",
      "id": "string",
      "jobTitle": "string"
    },
    "assigneeId": "string",
    "clientRef": "string",
    "completedAt": "2019-08-24T14:15:22Z",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "description": "string",
    "dueDate": "2019-08-24",
    "epic": {
      "color": "string",
      "id": "string",
      "name": "string"
    },
    "epicId": "string",
    "estimatedHours": 0.1,
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "feature": {
      "id": "string",
      "name": "string"
    },
    "featureId": "string",
    "id": "string",
    "labels": [
      "string"
    ],
    "links": [
      {
        "label": "string",
        "url": "string"
      }
    ],
    "name": "string",
    "priority": "LOW",
    "project": {
      "id": "string",
      "name": "string"
    },
    "sprint": {
      "id": "string",
      "name": "string"
    },
    "sprintId": "string",
    "status": "TODO",
    "storyPoints": 0,
    "taskType": "TASK",
    "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 tasks by sprint

GET
/hr/tasks/by-sprint/{sprintId}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

sprintId*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/hr/tasks/by-sprint/string"
[
  {
    "assigneeId": "string",
    "clientRef": "string",
    "completedAt": "2019-08-24T14:15:22Z",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "description": "string",
    "dueDate": "2019-08-24",
    "epicId": "string",
    "estimatedHours": 0.1,
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "featureId": "string",
    "id": "string",
    "labels": [
      "string"
    ],
    "links": [
      {
        "label": "string",
        "url": "string"
      }
    ],
    "name": "string",
    "priority": "LOW",
    "sprintId": "string",
    "status": "TODO",
    "storyPoints": 0,
    "taskType": "TASK",
    "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 tasks by status

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

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

status*string
Value in"TODO" | "IN_PROGRESS" | "IN_REVIEW" | "DONE"

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/hr/tasks/by-status/TODO"
[
  {
    "assigneeId": "string",
    "clientRef": "string",
    "completedAt": "2019-08-24T14:15:22Z",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "description": "string",
    "dueDate": "2019-08-24",
    "epicId": "string",
    "estimatedHours": 0.1,
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "featureId": "string",
    "id": "string",
    "labels": [
      "string"
    ],
    "links": [
      {
        "label": "string",
        "url": "string"
      }
    ],
    "name": "string",
    "priority": "LOW",
    "sprintId": "string",
    "status": "TODO",
    "storyPoints": 0,
    "taskType": "TASK",
    "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_ Task

GET
/hr/tasks/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/tasks/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/tasks/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/tasks/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_ Task

GET
/hr/tasks/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/tasks/dynamic-search"
{
  "content": [
    {
      "assigneeId": "string",
      "clientRef": "string",
      "completedAt": "2019-08-24T14:15:22Z",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "description": "string",
      "dueDate": "2019-08-24",
      "epicId": "string",
      "estimatedHours": 0.1,
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "featureId": "string",
      "id": "string",
      "labels": [
        "string"
      ],
      "links": [
        {
          "label": "string",
          "url": "string"
        }
      ],
      "name": "string",
      "priority": "LOW",
      "sprintId": "string",
      "status": "TODO",
      "storyPoints": 0,
      "taskType": "TASK",
      "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_ Task

POST
/hr/tasks/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/tasks/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": [
    {
      "assigneeId": "string",
      "clientRef": "string",
      "completedAt": "2019-08-24T14:15:22Z",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "description": "string",
      "dueDate": "2019-08-24",
      "epicId": "string",
      "estimatedHours": 0.1,
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "featureId": "string",
      "id": "string",
      "labels": [
        "string"
      ],
      "links": [
        {
          "label": "string",
          "url": "string"
        }
      ],
      "name": "string",
      "priority": "LOW",
      "sprintId": "string",
      "status": "TODO",
      "storyPoints": 0,
      "taskType": "TASK",
      "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/tasks/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/tasks/find?ids=string"
[
  {
    "assigneeId": "string",
    "clientRef": "string",
    "completedAt": "2019-08-24T14:15:22Z",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "description": "string",
    "dueDate": "2019-08-24",
    "epicId": "string",
    "estimatedHours": 0.1,
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "featureId": "string",
    "id": "string",
    "labels": [
      "string"
    ],
    "links": [
      {
        "label": "string",
        "url": "string"
      }
    ],
    "name": "string",
    "priority": "LOW",
    "sprintId": "string",
    "status": "TODO",
    "storyPoints": 0,
    "taskType": "TASK",
    "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/tasks/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/tasks/find-all"
[
  {
    "assigneeId": "string",
    "clientRef": "string",
    "completedAt": "2019-08-24T14:15:22Z",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "description": "string",
    "dueDate": "2019-08-24",
    "epicId": "string",
    "estimatedHours": 0.1,
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "featureId": "string",
    "id": "string",
    "labels": [
      "string"
    ],
    "links": [
      {
        "label": "string",
        "url": "string"
      }
    ],
    "name": "string",
    "priority": "LOW",
    "sprintId": "string",
    "status": "TODO",
    "storyPoints": 0,
    "taskType": "TASK",
    "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/tasks/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/tasks/find-list"
[
  {
    "assigneeId": "string",
    "clientRef": "string",
    "completedAt": "2019-08-24T14:15:22Z",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "description": "string",
    "dueDate": "2019-08-24",
    "epicId": "string",
    "estimatedHours": 0.1,
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "featureId": "string",
    "id": "string",
    "labels": [
      "string"
    ],
    "links": [
      {
        "label": "string",
        "url": "string"
      }
    ],
    "name": "string",
    "priority": "LOW",
    "sprintId": "string",
    "status": "TODO",
    "storyPoints": 0,
    "taskType": "TASK",
    "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/tasks/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/tasks/find/string"
{
  "assigneeId": "string",
  "clientRef": "string",
  "completedAt": "2019-08-24T14:15:22Z",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "description": "string",
  "dueDate": "2019-08-24",
  "epicId": "string",
  "estimatedHours": 0.1,
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "featureId": "string",
  "id": "string",
  "labels": [
    "string"
  ],
  "links": [
    {
      "label": "string",
      "url": "string"
    }
  ],
  "name": "string",
  "priority": "LOW",
  "sprintId": "string",
  "status": "TODO",
  "storyPoints": 0,
  "taskType": "TASK",
  "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 my tasks

GET
/hr/tasks/my

Authorization

AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/hr/tasks/my"
[
  {
    "assigneeId": "string",
    "clientRef": "string",
    "completedAt": "2019-08-24T14:15:22Z",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "description": "string",
    "dueDate": "2019-08-24",
    "epicId": "string",
    "estimatedHours": 0.1,
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "featureId": "string",
    "id": "string",
    "labels": [
      "string"
    ],
    "links": [
      {
        "label": "string",
        "url": "string"
      }
    ],
    "name": "string",
    "priority": "LOW",
    "sprintId": "string",
    "status": "TODO",
    "storyPoints": 0,
    "taskType": "TASK",
    "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 tasks

GET
/hr/tasks/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/tasks/page"
{
  "content": [
    {
      "assigneeId": "string",
      "clientRef": "string",
      "completedAt": "2019-08-24T14:15:22Z",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "description": "string",
      "dueDate": "2019-08-24",
      "epicId": "string",
      "estimatedHours": 0.1,
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "featureId": "string",
      "id": "string",
      "labels": [
        "string"
      ],
      "links": [
        {
          "label": "string",
          "url": "string"
        }
      ],
      "name": "string",
      "priority": "LOW",
      "sprintId": "string",
      "status": "TODO",
      "storyPoints": 0,
      "taskType": "TASK",
      "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 task

GET
/hr/tasks/{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/tasks/string"
{
  "assignee": {
    "avatar": "string",
    "department": "string",
    "email": "string",
    "fullName": "string",
    "id": "string",
    "jobTitle": "string"
  },
  "assigneeId": "string",
  "clientRef": "string",
  "completedAt": "2019-08-24T14:15:22Z",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "description": "string",
  "dueDate": "2019-08-24",
  "epic": {
    "color": "string",
    "id": "string",
    "name": "string"
  },
  "epicId": "string",
  "estimatedHours": 0.1,
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "feature": {
    "id": "string",
    "name": "string"
  },
  "featureId": "string",
  "id": "string",
  "labels": [
    "string"
  ],
  "links": [
    {
      "label": "string",
      "url": "string"
    }
  ],
  "name": "string",
  "priority": "LOW",
  "project": {
    "id": "string",
    "name": "string"
  },
  "sprint": {
    "id": "string",
    "name": "string"
  },
  "sprintId": "string",
  "status": "TODO",
  "storyPoints": 0,
  "taskType": "TASK",
  "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 task

PATCH
/hr/tasks/{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/tasks/string" \  -H "Content-Type: application/json" \  -d '{    "labels": [      "string"    ],    "links": [      {        "url": "string"      }    ],    "name": "string",    "priority": "LOW",    "status": "TODO",    "taskType": "TASK"  }'
{
  "assignee": {
    "avatar": "string",
    "department": "string",
    "email": "string",
    "fullName": "string",
    "id": "string",
    "jobTitle": "string"
  },
  "assigneeId": "string",
  "clientRef": "string",
  "completedAt": "2019-08-24T14:15:22Z",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "description": "string",
  "dueDate": "2019-08-24",
  "epic": {
    "color": "string",
    "id": "string",
    "name": "string"
  },
  "epicId": "string",
  "estimatedHours": 0.1,
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "feature": {
    "id": "string",
    "name": "string"
  },
  "featureId": "string",
  "id": "string",
  "labels": [
    "string"
  ],
  "links": [
    {
      "label": "string",
      "url": "string"
    }
  ],
  "name": "string",
  "priority": "LOW",
  "project": {
    "id": "string",
    "name": "string"
  },
  "sprint": {
    "id": "string",
    "name": "string"
  },
  "sprintId": "string",
  "status": "TODO",
  "storyPoints": 0,
  "taskType": "TASK",
  "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/tasks/{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/tasks/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"
}

Assign task

PATCH
/hr/tasks/{id}/assign

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

assigneeId?string

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "http://localhost:18080/api/v1/hr/tasks/string/assign" \  -H "Content-Type: application/json" \  -d '{}'
{
  "assignee": {
    "avatar": "string",
    "department": "string",
    "email": "string",
    "fullName": "string",
    "id": "string",
    "jobTitle": "string"
  },
  "assigneeId": "string",
  "clientRef": "string",
  "completedAt": "2019-08-24T14:15:22Z",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "description": "string",
  "dueDate": "2019-08-24",
  "epic": {
    "color": "string",
    "id": "string",
    "name": "string"
  },
  "epicId": "string",
  "estimatedHours": 0.1,
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "feature": {
    "id": "string",
    "name": "string"
  },
  "featureId": "string",
  "id": "string",
  "labels": [
    "string"
  ],
  "links": [
    {
      "label": "string",
      "url": "string"
    }
  ],
  "name": "string",
  "priority": "LOW",
  "project": {
    "id": "string",
    "name": "string"
  },
  "sprint": {
    "id": "string",
    "name": "string"
  },
  "sprintId": "string",
  "status": "TODO",
  "storyPoints": 0,
  "taskType": "TASK",
  "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"
}

Add a comment to an entity

POST
/hr/tasks/{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/tasks/string/comment" \  -H "Content-Type: application/json" \  -d 'string'
{
  "assignee": {
    "avatar": "string",
    "department": "string",
    "email": "string",
    "fullName": "string",
    "id": "string",
    "jobTitle": "string"
  },
  "assigneeId": "string",
  "clientRef": "string",
  "completedAt": "2019-08-24T14:15:22Z",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "description": "string",
  "dueDate": "2019-08-24",
  "epic": {
    "color": "string",
    "id": "string",
    "name": "string"
  },
  "epicId": "string",
  "estimatedHours": 0.1,
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "feature": {
    "id": "string",
    "name": "string"
  },
  "featureId": "string",
  "id": "string",
  "labels": [
    "string"
  ],
  "links": [
    {
      "label": "string",
      "url": "string"
    }
  ],
  "name": "string",
  "priority": "LOW",
  "project": {
    "id": "string",
    "name": "string"
  },
  "sprint": {
    "id": "string",
    "name": "string"
  },
  "sprintId": "string",
  "status": "TODO",
  "storyPoints": 0,
  "taskType": "TASK",
  "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"
}

Move task to sprint

PATCH
/hr/tasks/{id}/sprint

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

sprintId?string

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "http://localhost:18080/api/v1/hr/tasks/string/sprint" \  -H "Content-Type: application/json" \  -d '{}'
{
  "assignee": {
    "avatar": "string",
    "department": "string",
    "email": "string",
    "fullName": "string",
    "id": "string",
    "jobTitle": "string"
  },
  "assigneeId": "string",
  "clientRef": "string",
  "completedAt": "2019-08-24T14:15:22Z",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "description": "string",
  "dueDate": "2019-08-24",
  "epic": {
    "color": "string",
    "id": "string",
    "name": "string"
  },
  "epicId": "string",
  "estimatedHours": 0.1,
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "feature": {
    "id": "string",
    "name": "string"
  },
  "featureId": "string",
  "id": "string",
  "labels": [
    "string"
  ],
  "links": [
    {
      "label": "string",
      "url": "string"
    }
  ],
  "name": "string",
  "priority": "LOW",
  "project": {
    "id": "string",
    "name": "string"
  },
  "sprint": {
    "id": "string",
    "name": "string"
  },
  "sprintId": "string",
  "status": "TODO",
  "storyPoints": 0,
  "taskType": "TASK",
  "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 task status

PATCH
/hr/tasks/{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/tasks/string/status" \  -H "Content-Type: application/json" \  -d '{    "status": "TODO"  }'
{
  "assignee": {
    "avatar": "string",
    "department": "string",
    "email": "string",
    "fullName": "string",
    "id": "string",
    "jobTitle": "string"
  },
  "assigneeId": "string",
  "clientRef": "string",
  "completedAt": "2019-08-24T14:15:22Z",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "description": "string",
  "dueDate": "2019-08-24",
  "epic": {
    "color": "string",
    "id": "string",
    "name": "string"
  },
  "epicId": "string",
  "estimatedHours": 0.1,
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "feature": {
    "id": "string",
    "name": "string"
  },
  "featureId": "string",
  "id": "string",
  "labels": [
    "string"
  ],
  "links": [
    {
      "label": "string",
      "url": "string"
    }
  ],
  "name": "string",
  "priority": "LOW",
  "project": {
    "id": "string",
    "name": "string"
  },
  "sprint": {
    "id": "string",
    "name": "string"
  },
  "sprintId": "string",
  "status": "TODO",
  "storyPoints": 0,
  "taskType": "TASK",
  "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 Sprint

Previous Page

H R Team Agenda

Next Page