Mass Workflow Task Controller

Get Mass Workflow Task By ID

HTTP Request

GET /api/v1/batch/mass-workflow/tasks/{id}

📋 Description: Retrieves detailed information about a specific task within a mass workflow in the Nakisa Lease Accounting Suite, facilitating the management of lease contracts and associated financial obligations.

Parameters

Name

In

Type

Required

Description

id

path

integer

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseMassWorkflowTaskDto

Example Responses

 1{
 2  "code": {
 3    "name": "OK",
 4    "captionKey": "enum.responseCode.ok",
 5    "caption": "OK"
 6  },
 7  "errors": {
 8    "all": []
 9  },
10  "object": {
11    "id": 10000001,
12    "queueTime": "2025-01-01T10:00:00Z",
13    "startTime": "2025-01-01T10:00:00Z",
14    "endTime": "2025-01-01T10:00:00Z",
15    "interruptedAt": "2025-01-01T10:00:00Z",
16    "recoveredAt": "2025-01-01T10:00:00Z",
17    "status": {
18      "name": "PROCESSING",
19      "captionKey": "enum.batchJobStatus.processing",
20      "caption": "Processing"
21    },
22    "recover": false,
23    "interrupted": false,
24    "interruptionMessage": "sample_interruptionMessage",
25    "errorMessage": "sample_errorMessage",
26    "totalObjectCount": 100,
27    "jobId": 10000001,
28    "batchTaskObjectType": {
29      "name": "CONTRACT",
30      "captionKey": "enum.objectType.contract",
31      "caption": "Contract"
32    },
33    "objectBaseIds": [],
34    "taskReport": {
35      "id": 10000001,
36      "scheduledItemCount": 100,
37      "processingItemCount": 100,
38      "doneItemCount": 100,
39      "failedItemCount": 100,
40      "cancelledItemCount": 100,
41      "skippedItemCount": 100,
42      "totalItemCount": 100,
43      "taskId": 10000001,
44      "doneWithWarningItemCount": 100
45    },
46    "duty": {
47      "name": "GENERATE_WORKBOOK_TEMPLATE",
48      "captionKey": "enum.batchTaskDuty.generateWorkbookTemplate",
49      "caption": "Generate Workbook Template"
50    }
51  }
52}

Update Mass Workflow Task

HTTP Request

PUT /api/v1/batch/mass-workflow/tasks/{id}

📋 Description: Updates the specified task within a mass workflow in the Nakisa Lease Accounting Suite, allowing users to modify details related to leases, contracts, and financial obligations associated with accounting entries.

Parameters

Name

In

Type

Required

Description

id

path

integer

true

Unique identifier for the resource

body

body

MassWorkflowTaskDto

false

Request body containing the updated task details, including lease and contract information, financial obligations, and accounting entries associated with the specified task ID.

Body Parameters

 1{
 2  "id": 10000001,
 3  "queueTime": "2025-01-01T10:00:00Z",
 4  "startTime": "2025-01-01T10:00:00Z",
 5  "endTime": "2025-01-01T10:00:00Z",
 6  "interruptedAt": "2025-01-01T10:00:00Z",
 7  "recoveredAt": "2025-01-01T10:00:00Z",
 8  "status": {
 9    "name": "PROCESSING",
10    "captionKey": "enum.batchJobStatus.processing",
11    "caption": "Processing"
12  },
13  "recover": false,
14  "interrupted": false,
15  "interruptionMessage": "sample_interruptionMessage",
16  "errorMessage": "sample_errorMessage",
17  "totalObjectCount": 100,
18  "jobId": 10000001,
19  "batchTaskObjectType": {
20    "name": "CONTRACT",
21    "captionKey": "enum.objectType.contract",
22    "caption": "Contract"
23  },
24  "objectBaseIds": [],
25  "taskReport": {
26    "id": 10000001,
27    "scheduledItemCount": 100,
28    "processingItemCount": 100,
29    "doneItemCount": 100,
30    "failedItemCount": 100,
31    "cancelledItemCount": 100,
32    "skippedItemCount": 100,
33    "totalItemCount": 100,
34    "taskId": 10000001,
35    "doneWithWarningItemCount": 100
36  },
37  "duty": {
38    "name": "GENERATE_WORKBOOK_TEMPLATE",
39    "captionKey": "enum.batchTaskDuty.generateWorkbookTemplate",
40    "caption": "Generate Workbook Template"
41  }
42}

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseMassWorkflowTaskDto

Example Responses

 1{
 2  "code": {
 3    "name": "OK",
 4    "captionKey": "enum.responseCode.ok",
 5    "caption": "OK"
 6  },
 7  "errors": {
 8    "all": []
 9  },
10  "object": {
11    "id": 10000001,
12    "queueTime": "2025-01-01T10:00:00Z",
13    "startTime": "2025-01-01T10:00:00Z",
14    "endTime": "2025-01-01T10:00:00Z",
15    "interruptedAt": "2025-01-01T10:00:00Z",
16    "recoveredAt": "2025-01-01T10:00:00Z",
17    "status": {
18      "name": "PROCESSING",
19      "captionKey": "enum.batchJobStatus.processing",
20      "caption": "Processing"
21    },
22    "recover": false,
23    "interrupted": false,
24    "interruptionMessage": "sample_interruptionMessage",
25    "errorMessage": "sample_errorMessage",
26    "totalObjectCount": 100,
27    "jobId": 10000001,
28    "batchTaskObjectType": {
29      "name": "CONTRACT",
30      "captionKey": "enum.objectType.contract",
31      "caption": "Contract"
32    },
33    "objectBaseIds": [],
34    "taskReport": {
35      "id": 10000001,
36      "scheduledItemCount": 100,
37      "processingItemCount": 100,
38      "doneItemCount": 100,
39      "failedItemCount": 100,
40      "cancelledItemCount": 100,
41      "skippedItemCount": 100,
42      "totalItemCount": 100,
43      "taskId": 10000001,
44      "doneWithWarningItemCount": 100
45    },
46    "duty": {
47      "name": "GENERATE_WORKBOOK_TEMPLATE",
48      "captionKey": "enum.batchTaskDuty.generateWorkbookTemplate",
49      "caption": "Generate Workbook Template"
50    }
51  }
52}

Bulk Upsert Mass Workflow Tasks

HTTP Request

PUT /api/v1/batch/mass-workflow/tasks/createOrUpdate/bulk

📋 Description: Updates or creates multiple tasks within the Nakisa Lease Accounting Suite’s mass workflow, enabling efficient management of lease, contract, and financial obligation data in a single operation. This operation streamlines the process of maintaining accurate accounting entries by allowing bulk modifications.

Parameters

Name

In

Type

Required

Description

body

body

MassWorkflowTaskDto

false

Request body containing bulk data for creating or updating lease-related tasks, including contract details, financial obligations, and associated accounting entries.

Body Parameters

 1[
 2  {
 3    "id": 10000001,
 4    "queueTime": "2025-01-01T10:00:00Z",
 5    "startTime": "2025-01-01T10:00:00Z",
 6    "endTime": "2025-01-01T10:00:00Z",
 7    "interruptedAt": "2025-01-01T10:00:00Z",
 8    "recoveredAt": "2025-01-01T10:00:00Z",
 9    "status": {
10      "name": "PROCESSING",
11      "captionKey": "enum.batchJobStatus.processing",
12      "caption": "Processing"
13    },
14    "recover": false,
15    "interrupted": false,
16    "interruptionMessage": "sample_interruptionMessage",
17    "errorMessage": "sample_errorMessage",
18    "totalObjectCount": 100,
19    "jobId": 10000001,
20    "batchTaskObjectType": {
21      "name": "CONTRACT",
22      "captionKey": "enum.objectType.contract",
23      "caption": "Contract"
24    },
25    "objectBaseIds": [],
26    "taskReport": {
27      "id": 10000001,
28      "scheduledItemCount": 100,
29      "processingItemCount": 100,
30      "doneItemCount": 100,
31      "failedItemCount": 100,
32      "cancelledItemCount": 100,
33      "skippedItemCount": 100,
34      "totalItemCount": 100,
35      "taskId": 10000001,
36      "doneWithWarningItemCount": 100
37    },
38    "duty": {
39      "name": "GENERATE_WORKBOOK_TEMPLATE",
40      "captionKey": "enum.batchTaskDuty.generateWorkbookTemplate",
41      "caption": "Generate Workbook Template"
42    }
43  }
44]

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListMassWorkflowTaskDto

Example Responses

 1{
 2  "code": {
 3    "name": "OK",
 4    "captionKey": "enum.responseCode.ok",
 5    "caption": "OK"
 6  },
 7  "errors": {
 8    "all": []
 9  },
10  "object": []
11}

Upsert Mass Workflow Task

HTTP Request

PUT /api/v1/batch/mass-workflow/tasks/createOrUpdate

📋 Description: Updates or creates tasks within the mass workflow for lease and contract management in the Nakisa Lease Accounting Suite, ensuring accurate financial obligations and accounting entries are maintained.

Parameters

Name

In

Type

Required

Description

body

body

MassWorkflowTaskDto

false

Request body containing the lease and contract task data, including financial obligations and accounting entries, for creating or updating workflows in the Nakisa Lease Accounting Suite.

Body Parameters

 1{
 2  "id": 10000001,
 3  "queueTime": "2025-01-01T10:00:00Z",
 4  "startTime": "2025-01-01T10:00:00Z",
 5  "endTime": "2025-01-01T10:00:00Z",
 6  "interruptedAt": "2025-01-01T10:00:00Z",
 7  "recoveredAt": "2025-01-01T10:00:00Z",
 8  "status": {
 9    "name": "PROCESSING",
10    "captionKey": "enum.batchJobStatus.processing",
11    "caption": "Processing"
12  },
13  "recover": false,
14  "interrupted": false,
15  "interruptionMessage": "sample_interruptionMessage",
16  "errorMessage": "sample_errorMessage",
17  "totalObjectCount": 100,
18  "jobId": 10000001,
19  "batchTaskObjectType": {
20    "name": "CONTRACT",
21    "captionKey": "enum.objectType.contract",
22    "caption": "Contract"
23  },
24  "objectBaseIds": [],
25  "taskReport": {
26    "id": 10000001,
27    "scheduledItemCount": 100,
28    "processingItemCount": 100,
29    "doneItemCount": 100,
30    "failedItemCount": 100,
31    "cancelledItemCount": 100,
32    "skippedItemCount": 100,
33    "totalItemCount": 100,
34    "taskId": 10000001,
35    "doneWithWarningItemCount": 100
36  },
37  "duty": {
38    "name": "GENERATE_WORKBOOK_TEMPLATE",
39    "captionKey": "enum.batchTaskDuty.generateWorkbookTemplate",
40    "caption": "Generate Workbook Template"
41  }
42}

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseMassWorkflowTaskDto

Example Responses

 1{
 2  "code": {
 3    "name": "OK",
 4    "captionKey": "enum.responseCode.ok",
 5    "caption": "OK"
 6  },
 7  "errors": {
 8    "all": []
 9  },
10  "object": {
11    "id": 10000001,
12    "queueTime": "2025-01-01T10:00:00Z",
13    "startTime": "2025-01-01T10:00:00Z",
14    "endTime": "2025-01-01T10:00:00Z",
15    "interruptedAt": "2025-01-01T10:00:00Z",
16    "recoveredAt": "2025-01-01T10:00:00Z",
17    "status": {
18      "name": "PROCESSING",
19      "captionKey": "enum.batchJobStatus.processing",
20      "caption": "Processing"
21    },
22    "recover": false,
23    "interrupted": false,
24    "interruptionMessage": "sample_interruptionMessage",
25    "errorMessage": "sample_errorMessage",
26    "totalObjectCount": 100,
27    "jobId": 10000001,
28    "batchTaskObjectType": {
29      "name": "CONTRACT",
30      "captionKey": "enum.objectType.contract",
31      "caption": "Contract"
32    },
33    "objectBaseIds": [],
34    "taskReport": {
35      "id": 10000001,
36      "scheduledItemCount": 100,
37      "processingItemCount": 100,
38      "doneItemCount": 100,
39      "failedItemCount": 100,
40      "cancelledItemCount": 100,
41      "skippedItemCount": 100,
42      "totalItemCount": 100,
43      "taskId": 10000001,
44      "doneWithWarningItemCount": 100
45    },
46    "duty": {
47      "name": "GENERATE_WORKBOOK_TEMPLATE",
48      "captionKey": "enum.batchTaskDuty.generateWorkbookTemplate",
49      "caption": "Generate Workbook Template"
50    }
51  }
52}

Bulk Update Mass Workflow Tasks

HTTP Request

PUT /api/v1/batch/mass-workflow/tasks/bulk

📋 Description: Updates multiple tasks within a mass workflow in the Nakisa Lease Accounting Suite, enabling users to efficiently manage lease, contract, and financial obligation entries in bulk. This operation streamlines the accounting entry process, ensuring accurate and timely updates across related tasks.

Parameters

Name

In

Type

Required

Description

body

body

MassWorkflowTaskDto

false

Request body containing bulk task data related to lease management, contract processing, and financial obligations for efficient accounting entry updates.

Body Parameters

 1[
 2  {
 3    "id": 10000001,
 4    "queueTime": "2025-01-01T10:00:00Z",
 5    "startTime": "2025-01-01T10:00:00Z",
 6    "endTime": "2025-01-01T10:00:00Z",
 7    "interruptedAt": "2025-01-01T10:00:00Z",
 8    "recoveredAt": "2025-01-01T10:00:00Z",
 9    "status": {
10      "name": "PROCESSING",
11      "captionKey": "enum.batchJobStatus.processing",
12      "caption": "Processing"
13    },
14    "recover": false,
15    "interrupted": false,
16    "interruptionMessage": "sample_interruptionMessage",
17    "errorMessage": "sample_errorMessage",
18    "totalObjectCount": 100,
19    "jobId": 10000001,
20    "batchTaskObjectType": {
21      "name": "CONTRACT",
22      "captionKey": "enum.objectType.contract",
23      "caption": "Contract"
24    },
25    "objectBaseIds": [],
26    "taskReport": {
27      "id": 10000001,
28      "scheduledItemCount": 100,
29      "processingItemCount": 100,
30      "doneItemCount": 100,
31      "failedItemCount": 100,
32      "cancelledItemCount": 100,
33      "skippedItemCount": 100,
34      "totalItemCount": 100,
35      "taskId": 10000001,
36      "doneWithWarningItemCount": 100
37    },
38    "duty": {
39      "name": "GENERATE_WORKBOOK_TEMPLATE",
40      "captionKey": "enum.batchTaskDuty.generateWorkbookTemplate",
41      "caption": "Generate Workbook Template"
42    }
43  }
44]

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListMassWorkflowTaskDto

Example Responses

 1{
 2  "code": {
 3    "name": "OK",
 4    "captionKey": "enum.responseCode.ok",
 5    "caption": "OK"
 6  },
 7  "errors": {
 8    "all": []
 9  },
10  "object": []
11}

Search Mass Workflow Tasks

HTTP Request

POST /api/v1/batch/mass-workflow/tasks/search

📋 Description: Submits a search request for mass workflow tasks related to leases, contracts, and financial obligations within the Nakisa Lease Accounting Suite, enabling users to efficiently manage and track accounting entries.

Parameters

Name

In

Type

Required

Description

page

query

integer

false

Zero-based page index (0..N)

size

query

integer

false

The size of the page to be returned

sort

query

array[string]

false

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

body

body

MassWorkflowTaskDtoFilter

false

Request body containing search criteria and filters for retrieving tasks related to leases, contracts, financial obligations, and accounting entries within the Nakisa Lease Accounting Suite.

Default Values

Parameter

Default

Type

sort

["createdAt,ASC"]

query

Body Parameters

 1{
 2  "idIn": [],
 3  "idEqual": 10000001,
 4  "idLike": "sample_idLike",
 5  "createdAtGreaterThanOrEqual": "2025-01-01T10:00:00Z",
 6  "createdAtLessThanOrEqual": "2025-01-01T10:00:00Z",
 7  "createdByLike": "sample_createdByLike",
 8  "createdByEqual": "sample_createdByEqual",
 9  "modifiedAtGreaterThanOrEqual": "2025-01-01T10:00:00Z",
10  "modifiedAtLessThanOrEqual": "2025-01-01T10:00:00Z",
11  "modifiedByLike": "sample_modifiedByLike",
12  "modifiedByEqual": "sample_modifiedByEqual",
13  "queueTimeGreaterThanOrEqual": "2025-01-01T10:00:00Z",
14  "queueTimeLessThanOrEqual": "2025-01-01T10:00:00Z",
15  "startTimeGreaterThanOrEqual": "2025-01-01T10:00:00Z",
16  "startTimeLessThanOrEqual": "2025-01-01T10:00:00Z",
17  "endTimeGreaterThanOrEqual": "2025-01-01T10:00:00Z",
18  "endTimeLessThanOrEqual": "2025-01-01T10:00:00Z",
19  "statusIn": {
20    "name": "PROCESSING",
21    "captionKey": "enum.batchJobStatus.processing",
22    "caption": "Processing"
23  },
24  "statusEqual": {
25    "name": "PROCESSING",
26    "captionKey": "enum.batchJobStatus.processing",
27    "caption": "Processing"
28  },
29  "jobIdEqual": 10000001
30}

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageMassWorkflowTaskDto

Example Responses

 1{
 2  "totalElements": 10000001,
 3  "totalPages": 100,
 4  "pageable": {
 5    "pageNumber": 0,
 6    "unpaged": false,
 7    "paged": true,
 8    "pageSize": 100,
 9    "offset": 0,
10    "sort": {
11      "unsorted": false,
12      "sorted": true,
13      "empty": false
14    }
15  },
16  "numberOfElements": 100,
17  "size": 100,
18  "content": [],
19  "number": 100,
20  "sort": {
21    "unsorted": false,
22    "sorted": true,
23    "empty": false
24  },
25  "first": false,
26  "last": false,
27  "empty": false
28}

Cancel Mass Workflow Task

HTTP Request

POST /api/v1/batch/mass-workflow/tasks/cancel/{id}

📋 Description: Cancels a specified mass workflow task by its unique identifier, facilitating the management of lease-related processes, contract adjustments, and associated financial obligations within the Nakisa Lease Accounting Suite.

Parameters

Name

In

Type

Required

Description

id

path

integer

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

None

Bulk Cancel Mass Workflow Tasks

HTTP Request

POST /api/v1/batch/mass-workflow/tasks/cancel/bulk

📋 Description: Initiates a bulk cancellation of tasks related to lease contracts within the Nakisa Lease Accounting Suite, streamlining the management of financial obligations and accounting entries.

Parameters

Name

In

Type

Required

Description

body

body

array[integer]

false

Request body containing a list of task identifiers to cancel multiple lease-related workflows in bulk, ensuring efficient management of financial obligations and accounting entries.

Body Parameters

1[
2  0
3]

Responses

Status

Meaning

Description

Schema

200

OK

OK

None

List All Mass Workflow Tasks

HTTP Request

GET /api/v1/batch/mass-workflow/tasks

📋 Description: Retrieves a list of tasks associated with mass workflows in the Nakisa Lease Accounting Suite, enabling users to efficiently manage lease, contract, and financial obligation processes.

Parameters

Name

In

Type

Required

Description

pageable

query

Pageable

true

Indicates whether the results of the mass workflow tasks retrieval should be paginated, facilitating efficient management of lease and contract-related financial obligations within the Nakisa Lease Accounting Suite.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageMassWorkflowTaskDto

Example Responses

 1{
 2  "totalElements": 10000001,
 3  "totalPages": 100,
 4  "pageable": {
 5    "pageNumber": 0,
 6    "unpaged": false,
 7    "paged": true,
 8    "pageSize": 100,
 9    "offset": 0,
10    "sort": {
11      "unsorted": false,
12      "sorted": true,
13      "empty": false
14    }
15  },
16  "numberOfElements": 100,
17  "size": 100,
18  "content": [],
19  "number": 100,
20  "sort": {
21    "unsorted": false,
22    "sorted": true,
23    "empty": false
24  },
25  "first": false,
26  "last": false,
27  "empty": false
28}