Document Storage¶
Document Storage - Get¶
HTTP Request
GET /api/v1/document-storage/{id}
📋 Description: Returns the single resource with the given ID.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Resource ID |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": []
5 },
6 "object": {
7 "id": 0,
8 "name": "string",
9 "description": "string",
10 "category": "string",
11 "fromDate": "2019-08-24",
12 "toDate": "2019-08-24",
13 "format": "XLSB",
14 "size": 0.1,
15 "uploadStatus": "IN_PROGRESS",
16 "fileStorageId": "string",
17 "unauthorized": true
18 }
19}
Document Storage - Update¶
HTTP Request
PUT /api/v1/document-storage/{id}
📋 Description: Fully replaces the resource with the given ID. All fields in the request body are applied.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Resource ID |
body |
body |
true |
none |
Body Parameters
1{
2 "id": 0,
3 "name": "string",
4 "description": "string",
5 "category": "string",
6 "fromDate": "2019-08-24",
7 "toDate": "2019-08-24",
8 "format": "XLSB",
9 "size": 0.1,
10 "uploadStatus": "IN_PROGRESS",
11 "fileStorageId": "string",
12 "unauthorized": true
13}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": []
5 },
6 "object": {
7 "id": 0,
8 "name": "string",
9 "description": "string",
10 "category": "string",
11 "fromDate": "2019-08-24",
12 "toDate": "2019-08-24",
13 "format": "XLSB",
14 "size": 0.1,
15 "uploadStatus": "IN_PROGRESS",
16 "fileStorageId": "string",
17 "unauthorized": true
18 }
19}
Document Storage - Delete¶
HTTP Request
DELETE /api/v1/document-storage/{id}
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
none |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "OK",
3 "errors": {
4 "all": []
5 },
6 "object": {}
7}
Document Storage - Create Or Update Bulk¶
HTTP Request
PUT /api/v1/document-storage/createOrUpdate/bulk
📋 Description: Creates or updates multiple resources in a single request. Partial success: each item is processed independently. Items that pass validation are persisted; failed items are recorded in the response
errorslist. The response body always contains the successfully processed items alongside any per-item errors.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
none |
Body Parameters
1[
2 {
3 "id": 0,
4 "name": "string",
5 "description": "string",
6 "category": "string",
7 "fromDate": "2019-08-24",
8 "toDate": "2019-08-24",
9 "format": "XLSB",
10 "size": 0.1,
11 "uploadStatus": "IN_PROGRESS",
12 "fileStorageId": "string",
13 "unauthorized": true
14 }
15]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": []
5 },
6 "object": [
7 {
8 "id": 0,
9 "name": "string",
10 "description": "string",
11 "category": "string",
12 "fromDate": "2019-08-24",
13 "toDate": "2019-08-24",
14 "format": "XLSB",
15 "size": 0.1,
16 "uploadStatus": "IN_PROGRESS",
17 "fileStorageId": "string",
18 "unauthorized": true
19 }
20 ]
21}
Document Storage - Create Or Update¶
HTTP Request
PUT /api/v1/document-storage/createOrUpdate
📋 Description: Creates the resource if no matching record exists, or fully updates it if one is found. Idempotent: safe to call multiple times with the same payload.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
none |
Body Parameters
1{
2 "id": 0,
3 "name": "string",
4 "description": "string",
5 "category": "string",
6 "fromDate": "2019-08-24",
7 "toDate": "2019-08-24",
8 "format": "XLSB",
9 "size": 0.1,
10 "uploadStatus": "IN_PROGRESS",
11 "fileStorageId": "string",
12 "unauthorized": true
13}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": []
5 },
6 "object": {
7 "id": 0,
8 "name": "string",
9 "description": "string",
10 "category": "string",
11 "fromDate": "2019-08-24",
12 "toDate": "2019-08-24",
13 "format": "XLSB",
14 "size": 0.1,
15 "uploadStatus": "IN_PROGRESS",
16 "fileStorageId": "string",
17 "unauthorized": true
18 }
19}
Document Storage - Bulk Update¶
HTTP Request
PUT /api/v1/document-storage/bulk
📋 Description: Updates multiple resources in a single request. Partial success: each item is processed independently. Items that pass validation are updated; failed items are recorded in the response
errorslist. The response body always contains the successfully updated items alongside any per-item errors.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
none |
Body Parameters
1[
2 {
3 "id": 0,
4 "name": "string",
5 "description": "string",
6 "category": "string",
7 "fromDate": "2019-08-24",
8 "toDate": "2019-08-24",
9 "format": "XLSB",
10 "size": 0.1,
11 "uploadStatus": "IN_PROGRESS",
12 "fileStorageId": "string",
13 "unauthorized": true
14 }
15]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": []
5 },
6 "object": [
7 {
8 "id": 0,
9 "name": "string",
10 "description": "string",
11 "category": "string",
12 "fromDate": "2019-08-24",
13 "toDate": "2019-08-24",
14 "format": "XLSB",
15 "size": 0.1,
16 "uploadStatus": "IN_PROGRESS",
17 "fileStorageId": "string",
18 "unauthorized": true
19 }
20 ]
21}
Document Storage - Bulk Delete¶
HTTP Request
DELETE /api/v1/document-storage/bulk
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
array[integer] |
true |
none |
Body Parameters
1[
2 0
3]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "OK",
3 "errors": {
4 "all": []
5 },
6 "object": {}
7}
Document Storage - Search¶
HTTP Request
POST /api/v1/document-storage/search
📋 Description: Returns a paginated list of resources matching the given filter criteria. Pass null or an empty body to return all accessible records.
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 |
false |
none |
Default Values¶
Parameter |
Default |
Type |
|---|---|---|
page |
|
query |
size |
|
query |
sort |
|
query |
Parameter Constraints¶
Parameter |
Constraints |
|---|---|
page |
Min: 0 |
size |
Min: 1 |
Body Parameters
1{
2 "idIn": [
3 0
4 ],
5 "idEqual": 0,
6 "idLike": "string",
7 "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
8 "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
9 "createdByLike": "string",
10 "createdByEqual": "string",
11 "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
12 "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
13 "modifiedByLike": "string",
14 "modifiedByEqual": "string",
15 "nameLike": "string",
16 "nameEqual": "string",
17 "categoryLike": "string",
18 "categoryEqual": "string",
19 "fromDateGreaterThanOrEqual": "2019-08-24",
20 "toDateLessThanOrEqual": "2019-08-24",
21 "formatEqual": "XLSB"
22}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "totalElements": 0,
3 "totalPages": 0,
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": 0,
17 "size": 0,
18 "content": [
19 {
20 "id": 0,
21 "name": "string",
22 "description": "string",
23 "category": "string",
24 "fromDate": "2019-08-24",
25 "toDate": "2019-08-24",
26 "format": "XLSB",
27 "size": 0.1,
28 "uploadStatus": "IN_PROGRESS",
29 "fileStorageId": "string",
30 "unauthorized": true
31 }
32 ],
33 "number": 0,
34 "sort": {
35 "unsorted": false,
36 "sorted": true,
37 "empty": false
38 },
39 "first": true,
40 "last": true,
41 "empty": true
42}
Document Storage - Bulk Download¶
HTTP Request
POST /api/v1/document-storage/download/bulk
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
array[integer] |
true |
none |
Body Parameters
1[
2 0
3]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Document Storage - Search File Categories¶
HTTP Request
POST /api/v1/document-storage/document-storage-categories/search
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
object |
false |
none |
» filter |
body |
false |
none |
|
»» idIn |
body |
[integer] |
false |
none |
»» idEqual |
body |
integer(int64) |
false |
none |
»» idLike |
body |
string |
false |
none |
»» createdAtGreaterThanOrEqual |
body |
string(date-time) |
false |
none |
»» createdAtLessThanOrEqual |
body |
string(date-time) |
false |
none |
»» createdByLike |
body |
string |
false |
none |
»» createdByEqual |
body |
string |
false |
none |
»» modifiedAtGreaterThanOrEqual |
body |
string(date-time) |
false |
none |
»» modifiedAtLessThanOrEqual |
body |
string(date-time) |
false |
none |
»» modifiedByLike |
body |
string |
false |
none |
»» modifiedByEqual |
body |
string |
false |
none |
»» uiSelector |
body |
string |
false |
none |
»» nameLike |
body |
string |
false |
none |
» pageable |
body |
false |
Data transfer object representing a paginated collection of lease-related records, including contracts, financial obligations, and accounting entries, facilitating efficient data retrieval and management within the Nakisa Lease Accounting Suite. |
|
»» page |
body |
integer(int32) |
true |
Page number for pagination |
»» size |
body |
integer(int32) |
true |
Number of items per page |
»» sort |
body |
[string] |
false |
Sort order specification |
Example Values¶
Parameter |
Example |
Type |
|---|---|---|
»» page |
|
body |
»» size |
|
body |
»» sort |
|
body |
Parameter Constraints¶
Parameter |
Constraints |
|---|---|
»» page |
Min: 0 |
»» size |
Min: 1 |
Body Parameters
1{
2 "filter": {
3 "idIn": [
4 0
5 ],
6 "idEqual": 0,
7 "idLike": "string",
8 "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
9 "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
10 "createdByLike": "string",
11 "createdByEqual": "string",
12 "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
13 "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
14 "modifiedByLike": "string",
15 "modifiedByEqual": "string",
16 "uiSelector": "string",
17 "nameLike": "string"
18 },
19 "pageable": {
20 "page": 0,
21 "size": 10,
22 "sort": [
23 "id,asc",
24 "name,desc"
25 ]
26 }
27}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "totalElements": 0,
3 "totalPages": 0,
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": 0,
17 "size": 0,
18 "content": [
19 {
20 "id": 0,
21 "name": "string"
22 }
23 ],
24 "number": 0,
25 "sort": {
26 "unsorted": false,
27 "sorted": true,
28 "empty": false
29 },
30 "first": true,
31 "last": true,
32 "empty": true
33}
Document Storage - Find All¶
HTTP Request
GET /api/v1/document-storage
📋 Description: Returns a paginated list of all accessible resources ordered by ID. Prefer POST /search for filtered queries.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
none |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "totalElements": 0,
3 "totalPages": 0,
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": 0,
17 "size": 0,
18 "content": [
19 {
20 "id": 0,
21 "name": "string",
22 "description": "string",
23 "category": "string",
24 "fromDate": "2019-08-24",
25 "toDate": "2019-08-24",
26 "format": "XLSB",
27 "size": 0.1,
28 "uploadStatus": "IN_PROGRESS",
29 "fileStorageId": "string",
30 "unauthorized": true
31 }
32 ],
33 "number": 0,
34 "sort": {
35 "unsorted": false,
36 "sorted": true,
37 "empty": false
38 },
39 "first": true,
40 "last": true,
41 "empty": true
42}
Document Storage - Upload¶
HTTP Request
POST /api/v1/document-storage
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
object |
false |
none |
» request |
body |
true |
none |
|
»» id |
body |
integer(int64) |
false |
none |
»» name |
body |
string |
true |
none |
»» description |
body |
string |
false |
none |
»» category |
body |
string |
false |
none |
»» fromDate |
body |
string(date) |
false |
none |
»» toDate |
body |
string(date) |
false |
none |
»» format |
body |
string |
false |
none |
»» size |
body |
number(double) |
false |
none |
»» uploadStatus |
body |
string |
false |
none |
»» fileStorageId |
body |
string |
false |
none |
»» unauthorized |
body |
boolean |
false |
none |
» file |
body |
string(binary) |
true |
none |
Enumerated Values
Attribute |
Value |
|---|---|
»» format |
XLSB, ZIP |
»» uploadStatus |
FAILED, INVALID, IN_PROGRESS, UPLOADED |
Body Parameters
1{
2 "file": "string",
3 "request": {
4 "category": "string",
5 "description": "string",
6 "fileStorageId": "string",
7 "format": "XLSB",
8 "fromDate": "2019-08-24",
9 "id": 0,
10 "name": "string",
11 "size": 0.1,
12 "toDate": "2019-08-24",
13 "unauthorized": true,
14 "uploadStatus": "IN_PROGRESS"
15 }
16}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "id": 0,
3 "name": "string",
4 "description": "string",
5 "category": "string",
6 "fromDate": "2019-08-24",
7 "toDate": "2019-08-24",
8 "format": "XLSB",
9 "size": 0.1,
10 "uploadStatus": "IN_PROGRESS",
11 "fileStorageId": "string",
12 "unauthorized": true
13}
Document Storage - Get Legacy Report Supported File Type¶
HTTP Request
GET /api/v1/document-storage/supported-file-extensions
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 "XLSB"
3]
Response Schema
Document Storage - Download¶
HTTP Request
GET /api/v1/document-storage/download/{id}
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
none |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |