Mass Indexation Task

Get Mass Indexation Task By ID

HTTP Request

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

📋 Description: Retrieves the details of a specific mass indexation task by its unique identifier, facilitating effective management of lease contracts 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

ResponseMassIndexationTaskDto

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    "objectIds": [],
34    "failedObjectIds": [],
35    "taskReport": {
36      "id": 10000001,
37      "scheduledItemCount": 100,
38      "processingItemCount": 100,
39      "doneItemCount": 100,
40      "failedItemCount": 100,
41      "cancelledItemCount": 100,
42      "skippedItemCount": 100,
43      "totalItemCount": 100,
44      "taskId": 10000001
45    }
46  }
47}

Update Mass Indexation Task

HTTP Request

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

📋 Description: Updates the status and details of a specific mass indexation task identified by its ID within 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

body

body

MassIndexationTaskDto

false

Request body containing the mass indexation task details, including lease, contract, financial obligation, and accounting entry information for 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  "objectIds": [],
25  "failedObjectIds": [],
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  }
37}

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseMassIndexationTaskDto

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    "objectIds": [],
34    "failedObjectIds": [],
35    "taskReport": {
36      "id": 10000001,
37      "scheduledItemCount": 100,
38      "processingItemCount": 100,
39      "doneItemCount": 100,
40      "failedItemCount": 100,
41      "cancelledItemCount": 100,
42      "skippedItemCount": 100,
43      "totalItemCount": 100,
44      "taskId": 10000001
45    }
46  }
47}

Bulk Upsert Mass Indexation Tasks

HTTP Request

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

📋 Description: Creates or updates multiple mass indexation tasks within the Nakisa Lease Accounting Suite, enabling efficient management of leases, contracts, financial obligations, and accounting entries in bulk.

Parameters

Name

In

Type

Required

Description

body

body

MassIndexationTaskDto

false

Request body containing bulk data for creating or updating lease-related tasks, including contract details, financial obligations, and 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    "objectIds": [],
26    "failedObjectIds": [],
27    "taskReport": {
28      "id": 10000001,
29      "scheduledItemCount": 100,
30      "processingItemCount": 100,
31      "doneItemCount": 100,
32      "failedItemCount": 100,
33      "cancelledItemCount": 100,
34      "skippedItemCount": 100,
35      "totalItemCount": 100,
36      "taskId": 10000001
37    }
38  }
39]

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListMassIndexationTaskDto

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 Indexation Task

HTTP Request

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

📋 Description: Creates or updates mass indexation tasks within the Nakisa Lease Accounting Suite, facilitating the management of leases, contracts, financial obligations, and accounting entries efficiently. This operation ensures that relevant data is accurately reflected and maintained in the system.

Parameters

Name

In

Type

Required

Description

body

body

MassIndexationTaskDto

false

Request body containing the lease and contract details, including financial obligations and accounting entries, for creating or updating mass indexation tasks 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  "objectIds": [],
25  "failedObjectIds": [],
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  }
37}

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseMassIndexationTaskDto

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    "objectIds": [],
34    "failedObjectIds": [],
35    "taskReport": {
36      "id": 10000001,
37      "scheduledItemCount": 100,
38      "processingItemCount": 100,
39      "doneItemCount": 100,
40      "failedItemCount": 100,
41      "cancelledItemCount": 100,
42      "skippedItemCount": 100,
43      "totalItemCount": 100,
44      "taskId": 10000001
45    }
46  }
47}

Bulk Update Mass Indexation Tasks

HTTP Request

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

📋 Description: Updates multiple mass indexation tasks in the Nakisa Lease Accounting Suite, enabling efficient management of leases, contracts, financial obligations, and accounting entries in bulk.

Parameters

Name

In

Type

Required

Description

body

body

MassIndexationTaskDto

false

Request body containing a collection of lease and contract data for bulk mass indexation tasks, including associated financial obligations and 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    "objectIds": [],
26    "failedObjectIds": [],
27    "taskReport": {
28      "id": 10000001,
29      "scheduledItemCount": 100,
30      "processingItemCount": 100,
31      "doneItemCount": 100,
32      "failedItemCount": 100,
33      "cancelledItemCount": 100,
34      "skippedItemCount": 100,
35      "totalItemCount": 100,
36      "taskId": 10000001
37    }
38  }
39]

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListMassIndexationTaskDto

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 Indexation Tasks

HTTP Request

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

📋 Description: Submits a request to search for mass indexation tasks related to leases, contracts, financial obligations, and accounting entries within the Nakisa Lease Accounting Suite.

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

MassIndexationTaskDtoFilter

false

Request body containing search criteria for lease, contract, financial obligation, and accounting entry tasks to facilitate mass indexation 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

PageMassIndexationTaskDto

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 Indexation Task

HTTP Request

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

📋 Description: Cancels a specified mass indexation task identified by the provided ID, ensuring the accurate management of lease and contract-related 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 Indexation Tasks

HTTP Request

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

📋 Description: Cancels multiple mass indexation tasks related to lease and contract management within the Nakisa Lease Accounting Suite, ensuring accurate financial obligation and accounting entry adjustments.

Parameters

Name

In

Type

Required

Description

body

body

array[integer]

false

Request body containing an array of task identifiers for cancelling multiple lease-related mass indexation tasks within the Nakisa Lease Accounting Suite.

Body Parameters

1[
2  0
3]

Responses

Status

Meaning

Description

Schema

200

OK

OK

None

List All Mass Indexation Tasks

HTTP Request

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

📋 Description: Retrieves a list of mass indexation tasks related to leases and contracts within the Nakisa Lease Accounting Suite, facilitating the management of financial obligations and accounting entries.

Parameters

Name

In

Type

Required

Description

pageable

query

Pageable

true

Indicates whether the results of the mass indexation tasks should be returned in a paginated format, facilitating efficient retrieval of lease and contract-related data within the Nakisa Lease Accounting Suite.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageMassIndexationTaskDto

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}