Alma logo
API docs by Redocly

Task Management API (1.0)

Download OpenAPI specification:Download

Introduction

Task Management API allows an agent to manage tasks

Contact

If you have any questions, comments or feedback regarding our APIs, please contact developer@ovipro.fi.

Task

Task Management API allows you to manage tasks

Create a new task

Create a new task.

Authorizations:
bearerAuth
header Parameters
Request-ID
required
string <uuid>
Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9

A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes.

Request Body schema: application/json
required

Request body contains details of the task.

typeCode
required
string (TaskTypeCode)
Enum: "CALL" "NOTIFICATION" "EMAIL" "TRAINING" "MEETING" "FOLLOW_UP" "REPORT_MEETING" "OTHER"

The type of task.

statusCode
required
string (StatusCode)
Enum: "WAITING" "DONE" "REJECTED"

The status of the task.

  • WAITING. Task is waiting for the next action.
  • DONE. Task have been done. In this state task statusCode cant be changed and parties and taskDueTime can't be modified anymore.
  • REJECTED. Task have been rejected. In this state task statusCode cant be changed and parties and taskDueTime can't be modified anymore.
description
string

Description of the task.

taskDueTime
required
string <date-time>

The end date and time of the task.

required
Array of objects

The parties related to the task.

realtyId
string <uuid>

The realty id related to the task.

assignmentId
string <uuid>

The assignment id related to the task.

agencyOfficeId
required
string <uuid>

The agency office id related to the task.

required
Array of objects non-empty

The agents related to the task.

Responses

Request samples

Content type
application/json
{
  • "typeCode": "REPORT_MEETING",
  • "statusCode": "WAITING",
  • "description": "Call to the customer",
  • "taskDueTime": "2022-12-31T23:59:59Z",
  • "parties": [
    ],
  • "realtyId": "123e4567-e89b-12d3-a456-426655440000",
  • "assignmentId": "123e4567-e89b-12d3-a456-426655440000",
  • "agencyOfficeId": "123e4567-e89b-12d3-a456-426655440000",
  • "agents": [
    ]
}

Response samples

Content type
application/json
{
  • "taskId": "c6d2288d-2ecb-448a-aef3-fd5144920e0b"
}

Search tasks

Search tasks.

Authorizations:
bearerAuth
query Parameters
typeCode
Array of strings (TaskTypeCode)
Items Enum: "CALL" "NOTIFICATION" "EMAIL" "TRAINING" "MEETING" "FOLLOW_UP" "REPORT_MEETING" "OTHER"
Example: typeCode=REPORT_MEETING
statusCode
Array of strings (StatusCode)
Items Enum: "WAITING" "DONE" "REJECTED"
Example: statusCode=WAITING
agencyOfficeId
Array of strings <uuid> [ items <uuid > ]
Example: agencyOfficeId=123e4567-e89b-12d3-a456-426655440000

Search by the agency office id to get a list of tasks.

realtyId
Array of strings <uuid> [ items <uuid > ]
Example: realtyId=123e4567-e89b-12d3-a456-426655440000

Search by the realty id to get a list of tasks related to realty.

partyId
Array of strings <uuid> [ items <uuid > ]
Example: partyId=123e4567-e89b-12d3-a456-426655440000

Search by the party id to get a list of tasks related to party.

agentId
Array of strings <uuid> [ items <uuid > ]
Example: agentId=7a931ef1-955f-4e67-a7b5-70301a38a8f7

Search by the agent id to get a list of tasks related to agent.

freeTextSearch
string

Search with free text to match task information with the given search text.

taskTimeBefore
string <date-time>

Search by the date to get a list of tasks happening before the given date.

taskTimeAfter
string <date-time>

Search by the date to get a list of tasks happening after the given date.

modifiedAfter
string <date-time>

Search by the modification time to get a list of tasks that were modified after given timestamp.

startIndex
integer <int32> >= 0
Default: 0
Example: startIndex=20

Paginate returned tasks starting from this index. Index starts from 0.

size
integer <int32> [ 1 .. 100 ]
Default: 50
Example: size=40

Tasks returned per page.

sort
Array of strings
Example: sort=taskDueTime|desc

Sort tasks based on the specified fields. Each fields must also include a sort order as follows:

sort={fieldName}|{asc|desc}&sort={anotherFieldName}|{asc|desc}

Supported sort fields are:

  • taskDueTime
  • modificationTime
header Parameters
Request-ID
required
string <uuid>
Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9

A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes.

Responses

Response samples

Content type
application/json
{
  • "tasks": [
    ],
  • "totalCount": 10
}

Get details of a task

Get details of a task.

Authorizations:
bearerAuth
path Parameters
taskId
required
string <uuid>
Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9

Identifier of the task

header Parameters
Request-ID
required
string <uuid>
Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9

A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes.

Responses

Response samples

Content type
application/json
{
  • "taskId": "c6d2288d-2ecb-448a-aef3-fd5144920e0b",
  • "typeCode": "REPORT_MEETING",
  • "statusCode": "WAITING",
  • "description": "Call to the customer",
  • "taskDueTime": "2022-12-31T23:59:59Z",
  • "parties": [
    ],
  • "realtyId": "123e4567-e89b-12d3-a456-426655440000",
  • "assignmentId": "123e4567-e89b-12d3-a456-426655440000",
  • "agencyOfficeId": "123e4567-e89b-12d3-a456-426655440000",
  • "agents": [
    ]
}

Delete a task

Delete a task. Task can be deleted only if it is in WAITING state.

Authorizations:
bearerAuth
path Parameters
taskId
required
string <uuid>
Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9

Identifier of the task

header Parameters
Request-ID
required
string <uuid>
Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9

A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes.

Responses

Response samples

Content type
application/json
{
  • "errorCode": "BAD_REQUEST_PARAMETERS",
  • "message": "Invalid request parameters",
  • "description": "Request parameters are missing or have invalid type.",
  • "errors": [
    ]
}

Update a task

Update a task. Note that when tasks statusCode is set to DONE or REJECTED "parties" and taskDueTime can't be modified anymore.

Authorizations:
bearerAuth
path Parameters
taskId
required
string <uuid>
Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9

Identifier of the task

header Parameters
Request-ID
required
string <uuid>
Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9

A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes.

Request Body schema: application/json
required

Request body contains details of the task.

typeCode
required
string (TaskTypeCode)
Enum: "CALL" "NOTIFICATION" "EMAIL" "TRAINING" "MEETING" "FOLLOW_UP" "REPORT_MEETING" "OTHER"

The type of task.

statusCode
required
string (StatusCode)
Enum: "WAITING" "DONE" "REJECTED"

The status of the task.

  • WAITING. Task is waiting for the next action.
  • DONE. Task have been done. In this state task statusCode cant be changed and parties and taskDueTime can't be modified anymore.
  • REJECTED. Task have been rejected. In this state task statusCode cant be changed and parties and taskDueTime can't be modified anymore.
description
string

Description of the task.

taskDueTime
required
string <date-time>

The end date and time of the task.

required
Array of objects

The parties related to the task.

realtyId
string <uuid>

The realty id related to the task.

assignmentId
string <uuid>

The assignment id related to the task.

agencyOfficeId
required
string <uuid>

The agency office id related to the task.

required
Array of objects non-empty

The agents related to the task.

Responses

Request samples

Content type
application/json
{
  • "typeCode": "REPORT_MEETING",
  • "statusCode": "WAITING",
  • "description": "Call to the customer",
  • "taskDueTime": "2022-12-31T23:59:59Z",
  • "parties": [
    ],
  • "realtyId": "123e4567-e89b-12d3-a456-426655440000",
  • "assignmentId": "123e4567-e89b-12d3-a456-426655440000",
  • "agencyOfficeId": "123e4567-e89b-12d3-a456-426655440000",
  • "agents": [
    ]
}

Response samples

Content type
application/json
{
  • "errorCode": "BAD_REQUEST_PARAMETERS",
  • "message": "Invalid request parameters",
  • "description": "Request parameters are missing or have invalid type.",
  • "errors": [
    ]
}