Excel Upload History

Get Excel Upload Histories

HTTP Request

GET /api/excel-upload-histories

📋 Description: Retrieves the history of Excel uploads related to portfolio and asset management within the Nakisa Portfolio Management Suite, providing insights for analytics and real estate property assessments.

Parameters

Name

In

Type

Required

Description

pageable

query

Pageable

true

Indicates whether the results of the Excel upload histories should be returned in a paginated format, facilitating efficient data retrieval for portfolio and asset analytics within the Nakisa Portfolio Management Suite.

entity-id

query

string

false

Unique identifier for the specific portfolio asset within the Nakisa Portfolio Management Suite, used to retrieve its associated Excel upload history.

file-name-like

query

string

false

Specifies a pattern to filter the uploaded Excel file names in the portfolio management suite, facilitating efficient retrieval of asset and analytics data related to real estate properties.

description-like

query

string

false

Filters the results of the Excel upload histories based on a descriptive string, enabling users to efficiently analyze portfolio and asset data within the Nakisa Portfolio Management Suite.

document-id

query

string

false

Unique identifier for the uploaded document within the portfolio management system, facilitating access to historical data related to asset analytics and real estate properties.

data-merge-type-id-in

query

string

false

Specifies the unique identifier for the data merge type, enabling targeted retrieval of historical Excel upload records related to portfolio, asset, and real estate property analytics.

start-time-after

query

string

false

Specifies the earliest timestamp for retrieving Excel upload histories related to portfolio, asset, and real estate property analytics.

end-time-before

query

string

false

Specifies the end time threshold for filtering Excel upload histories, enabling users to retrieve records relevant to portfolio, asset, and real estate property analytics.

data-merge-status-id-in

query

string

false

Specifies the unique identifier for the data merge status, allowing users to filter Excel upload histories relevant to portfolio, asset, analytics, and real estate property management.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PagedModelEntityModelExcelUploadHistoryDto

Example Responses

 1{
 2  "_embedded": {
 3    "excelUploadHistories": [
 4      {
 5        "createdBy": "string",
 6        "lastModifiedBy": "string",
 7        "createdDate": "2019-08-24T14:15:22Z",
 8        "lastModifiedDate": "2019-08-24T14:15:22Z",
 9        "archived": true,
10        "externalId": "string",
11        "id": 0,
12        "fileName": "string",
13        "startTime": "2019-08-24T14:15:22Z",
14        "endTime": "2019-08-24T14:15:22Z",
15        "dataMergeTypeId": 0,
16        "dataMergeStatusId": 0,
17        "documentId": 0,
18        "results": "string",
19        "description": "string",
20        "identifier": "string",
21        "totalChunks": 0,
22        "fileType": "string",
23        "targetEntityDisplayId": "string",
24        "targetEntityMenu": "string",
25        "targetEntityType": "string",
26        "dataMergeType": {
27          "createdBy": "string",
28          "lastModifiedBy": "string",
29          "createdDate": "2019-08-24T14:15:22Z",
30          "lastModifiedDate": "2019-08-24T14:15:22Z",
31          "archived": true,
32          "externalId": "string",
33          "id": 0,
34          "priority": 0,
35          "internalId": 0,
36          "pickListCode": "string",
37          "pickListLabel": "string",
38          "label": "string",
39          "cultureId": 0,
40          "labelDtos": [
41            {
42              "createdBy": "string",
43              "lastModifiedBy": "string",
44              "createdDate": "2019-08-24T14:15:22Z",
45              "lastModifiedDate": "2019-08-24T14:15:22Z",
46              "archived": true,
47              "externalId": "string",
48              "id": 0,
49              "cultureId": 0,
50              "value": "string"
51            }
52          ]
53        },
54        "dataMergeStatus": {
55          "createdBy": "string",
56          "lastModifiedBy": "string",
57          "createdDate": "2019-08-24T14:15:22Z",
58          "lastModifiedDate": "2019-08-24T14:15:22Z",
59          "archived": true,
60          "externalId": "string",
61          "id": 0,
62          "priority": 0,
63          "internalId": 0,
64          "pickListCode": "string",
65          "pickListLabel": "string",
66          "label": "string",
67          "cultureId": 0,
68          "labelDtos": [
69            {
70              "createdBy": "string",
71              "lastModifiedBy": "string",
72              "createdDate": "2019-08-24T14:15:22Z",
73              "lastModifiedDate": "2019-08-24T14:15:22Z",
74              "archived": true,
75              "externalId": "string",
76              "id": 0,
77              "cultureId": 0,
78              "value": "string"
79            }
80          ]
81        },
82        "customSheetList": [
83          "string"
84        ],
85        "currentSheetName": "string",
86        "runningExcelImportTasks": 0,
87        "processStatus": "NOT_STARTED",
88        "currentDataMergeStatusId": 0,
89        "update": true
90      }
91    ]
92  },
93  "page": {
94    "size": 0,
95    "totalElements": 0,
96    "totalPages": 0,
97    "number": 0
98  }
99}

Create Excel Upload History

HTTP Request

POST /api/excel-upload-histories

📋 Description: Uploads Excel files containing historical data related to portfolio and asset management, enabling enhanced analytics for real estate properties within the Nakisa Portfolio Management Suite.

Parameters

Name

In

Type

Required

Description

body

body

ExcelUploadHistoryDto

true

Request body containing the historical data for Excel uploads related to portfolio and asset analytics within the Nakisa Portfolio Management Suite.

Body Parameters

 1{
 2  "createdBy": "string",
 3  "lastModifiedBy": "string",
 4  "createdDate": "2019-08-24T14:15:22Z",
 5  "lastModifiedDate": "2019-08-24T14:15:22Z",
 6  "archived": true,
 7  "externalId": "string",
 8  "id": 0,
 9  "fileName": "string",
10  "startTime": "2019-08-24T14:15:22Z",
11  "endTime": "2019-08-24T14:15:22Z",
12  "dataMergeTypeId": 0,
13  "dataMergeStatusId": 0,
14  "documentId": 0,
15  "results": "string",
16  "description": "string",
17  "identifier": "string",
18  "totalChunks": 0,
19  "fileType": "string",
20  "targetEntityDisplayId": "string",
21  "targetEntityMenu": "string",
22  "targetEntityType": "string",
23  "dataMergeType": {
24    "createdBy": "string",
25    "lastModifiedBy": "string",
26    "createdDate": "2019-08-24T14:15:22Z",
27    "lastModifiedDate": "2019-08-24T14:15:22Z",
28    "archived": true,
29    "externalId": "string",
30    "id": 0,
31    "priority": 0,
32    "internalId": 0,
33    "pickListCode": "string",
34    "pickListLabel": "string",
35    "label": "string",
36    "cultureId": 0,
37    "labelDtos": [
38      {
39        "createdBy": "string",
40        "lastModifiedBy": "string",
41        "createdDate": "2019-08-24T14:15:22Z",
42        "lastModifiedDate": "2019-08-24T14:15:22Z",
43        "archived": true,
44        "externalId": "string",
45        "id": 0,
46        "cultureId": 0,
47        "value": "string"
48      }
49    ]
50  },
51  "dataMergeStatus": {
52    "createdBy": "string",
53    "lastModifiedBy": "string",
54    "createdDate": "2019-08-24T14:15:22Z",
55    "lastModifiedDate": "2019-08-24T14:15:22Z",
56    "archived": true,
57    "externalId": "string",
58    "id": 0,
59    "priority": 0,
60    "internalId": 0,
61    "pickListCode": "string",
62    "pickListLabel": "string",
63    "label": "string",
64    "cultureId": 0,
65    "labelDtos": [
66      {
67        "createdBy": "string",
68        "lastModifiedBy": "string",
69        "createdDate": "2019-08-24T14:15:22Z",
70        "lastModifiedDate": "2019-08-24T14:15:22Z",
71        "archived": true,
72        "externalId": "string",
73        "id": 0,
74        "cultureId": 0,
75        "value": "string"
76      }
77    ]
78  },
79  "customSheetList": [
80    "string"
81  ],
82  "currentSheetName": "string",
83  "runningExcelImportTasks": 0,
84  "processStatus": "NOT_STARTED",
85  "currentDataMergeStatusId": 0,
86  "update": true
87}

Responses

Status

Meaning

Description

Schema

201

Created

Created

ExcelUploadHistoryDto

Example Responses

 1{
 2  "createdBy": "string",
 3  "lastModifiedBy": "string",
 4  "createdDate": "2019-08-24T14:15:22Z",
 5  "lastModifiedDate": "2019-08-24T14:15:22Z",
 6  "archived": true,
 7  "externalId": "string",
 8  "id": 0,
 9  "fileName": "string",
10  "startTime": "2019-08-24T14:15:22Z",
11  "endTime": "2019-08-24T14:15:22Z",
12  "dataMergeTypeId": 0,
13  "dataMergeStatusId": 0,
14  "documentId": 0,
15  "results": "string",
16  "description": "string",
17  "identifier": "string",
18  "totalChunks": 0,
19  "fileType": "string",
20  "targetEntityDisplayId": "string",
21  "targetEntityMenu": "string",
22  "targetEntityType": "string",
23  "dataMergeType": {
24    "createdBy": "string",
25    "lastModifiedBy": "string",
26    "createdDate": "2019-08-24T14:15:22Z",
27    "lastModifiedDate": "2019-08-24T14:15:22Z",
28    "archived": true,
29    "externalId": "string",
30    "id": 0,
31    "priority": 0,
32    "internalId": 0,
33    "pickListCode": "string",
34    "pickListLabel": "string",
35    "label": "string",
36    "cultureId": 0,
37    "labelDtos": [
38      {
39        "createdBy": "string",
40        "lastModifiedBy": "string",
41        "createdDate": "2019-08-24T14:15:22Z",
42        "lastModifiedDate": "2019-08-24T14:15:22Z",
43        "archived": true,
44        "externalId": "string",
45        "id": 0,
46        "cultureId": 0,
47        "value": "string"
48      }
49    ]
50  },
51  "dataMergeStatus": {
52    "createdBy": "string",
53    "lastModifiedBy": "string",
54    "createdDate": "2019-08-24T14:15:22Z",
55    "lastModifiedDate": "2019-08-24T14:15:22Z",
56    "archived": true,
57    "externalId": "string",
58    "id": 0,
59    "priority": 0,
60    "internalId": 0,
61    "pickListCode": "string",
62    "pickListLabel": "string",
63    "label": "string",
64    "cultureId": 0,
65    "labelDtos": [
66      {
67        "createdBy": "string",
68        "lastModifiedBy": "string",
69        "createdDate": "2019-08-24T14:15:22Z",
70        "lastModifiedDate": "2019-08-24T14:15:22Z",
71        "archived": true,
72        "externalId": "string",
73        "id": 0,
74        "cultureId": 0,
75        "value": "string"
76      }
77    ]
78  },
79  "customSheetList": [
80    "string"
81  ],
82  "currentSheetName": "string",
83  "runningExcelImportTasks": 0,
84  "processStatus": "NOT_STARTED",
85  "currentDataMergeStatusId": 0,
86  "update": true
87}

Archive Excel Upload History

HTTP Request

POST /api/excel-upload-histories/{id}/archive

📋 Description: Archives the specified Excel upload history for a portfolio asset within the Nakisa Portfolio Management Suite, enabling streamlined management and analytics of real estate property data.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

ExcelUploadHistoryDto

Example Responses

 1{
 2  "createdBy": "string",
 3  "lastModifiedBy": "string",
 4  "createdDate": "2019-08-24T14:15:22Z",
 5  "lastModifiedDate": "2019-08-24T14:15:22Z",
 6  "archived": true,
 7  "externalId": "string",
 8  "id": 0,
 9  "fileName": "string",
10  "startTime": "2019-08-24T14:15:22Z",
11  "endTime": "2019-08-24T14:15:22Z",
12  "dataMergeTypeId": 0,
13  "dataMergeStatusId": 0,
14  "documentId": 0,
15  "results": "string",
16  "description": "string",
17  "identifier": "string",
18  "totalChunks": 0,
19  "fileType": "string",
20  "targetEntityDisplayId": "string",
21  "targetEntityMenu": "string",
22  "targetEntityType": "string",
23  "dataMergeType": {
24    "createdBy": "string",
25    "lastModifiedBy": "string",
26    "createdDate": "2019-08-24T14:15:22Z",
27    "lastModifiedDate": "2019-08-24T14:15:22Z",
28    "archived": true,
29    "externalId": "string",
30    "id": 0,
31    "priority": 0,
32    "internalId": 0,
33    "pickListCode": "string",
34    "pickListLabel": "string",
35    "label": "string",
36    "cultureId": 0,
37    "labelDtos": [
38      {
39        "createdBy": "string",
40        "lastModifiedBy": "string",
41        "createdDate": "2019-08-24T14:15:22Z",
42        "lastModifiedDate": "2019-08-24T14:15:22Z",
43        "archived": true,
44        "externalId": "string",
45        "id": 0,
46        "cultureId": 0,
47        "value": "string"
48      }
49    ]
50  },
51  "dataMergeStatus": {
52    "createdBy": "string",
53    "lastModifiedBy": "string",
54    "createdDate": "2019-08-24T14:15:22Z",
55    "lastModifiedDate": "2019-08-24T14:15:22Z",
56    "archived": true,
57    "externalId": "string",
58    "id": 0,
59    "priority": 0,
60    "internalId": 0,
61    "pickListCode": "string",
62    "pickListLabel": "string",
63    "label": "string",
64    "cultureId": 0,
65    "labelDtos": [
66      {
67        "createdBy": "string",
68        "lastModifiedBy": "string",
69        "createdDate": "2019-08-24T14:15:22Z",
70        "lastModifiedDate": "2019-08-24T14:15:22Z",
71        "archived": true,
72        "externalId": "string",
73        "id": 0,
74        "cultureId": 0,
75        "value": "string"
76      }
77    ]
78  },
79  "customSheetList": [
80    "string"
81  ],
82  "currentSheetName": "string",
83  "runningExcelImportTasks": 0,
84  "processStatus": "NOT_STARTED",
85  "currentDataMergeStatusId": 0,
86  "update": true
87}

Get Excel Upload History

HTTP Request

GET /api/excel-upload-histories/{id}

📋 Description: Fetches the upload history details for a specific Excel file associated with portfolio assets, enabling users to track and analyze real estate property data within the Nakisa Portfolio Management Suite.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

ExcelUploadHistoryDto

Example Responses

 1{
 2  "createdBy": "string",
 3  "lastModifiedBy": "string",
 4  "createdDate": "2019-08-24T14:15:22Z",
 5  "lastModifiedDate": "2019-08-24T14:15:22Z",
 6  "archived": true,
 7  "externalId": "string",
 8  "id": 0,
 9  "fileName": "string",
10  "startTime": "2019-08-24T14:15:22Z",
11  "endTime": "2019-08-24T14:15:22Z",
12  "dataMergeTypeId": 0,
13  "dataMergeStatusId": 0,
14  "documentId": 0,
15  "results": "string",
16  "description": "string",
17  "identifier": "string",
18  "totalChunks": 0,
19  "fileType": "string",
20  "targetEntityDisplayId": "string",
21  "targetEntityMenu": "string",
22  "targetEntityType": "string",
23  "dataMergeType": {
24    "createdBy": "string",
25    "lastModifiedBy": "string",
26    "createdDate": "2019-08-24T14:15:22Z",
27    "lastModifiedDate": "2019-08-24T14:15:22Z",
28    "archived": true,
29    "externalId": "string",
30    "id": 0,
31    "priority": 0,
32    "internalId": 0,
33    "pickListCode": "string",
34    "pickListLabel": "string",
35    "label": "string",
36    "cultureId": 0,
37    "labelDtos": [
38      {
39        "createdBy": "string",
40        "lastModifiedBy": "string",
41        "createdDate": "2019-08-24T14:15:22Z",
42        "lastModifiedDate": "2019-08-24T14:15:22Z",
43        "archived": true,
44        "externalId": "string",
45        "id": 0,
46        "cultureId": 0,
47        "value": "string"
48      }
49    ]
50  },
51  "dataMergeStatus": {
52    "createdBy": "string",
53    "lastModifiedBy": "string",
54    "createdDate": "2019-08-24T14:15:22Z",
55    "lastModifiedDate": "2019-08-24T14:15:22Z",
56    "archived": true,
57    "externalId": "string",
58    "id": 0,
59    "priority": 0,
60    "internalId": 0,
61    "pickListCode": "string",
62    "pickListLabel": "string",
63    "label": "string",
64    "cultureId": 0,
65    "labelDtos": [
66      {
67        "createdBy": "string",
68        "lastModifiedBy": "string",
69        "createdDate": "2019-08-24T14:15:22Z",
70        "lastModifiedDate": "2019-08-24T14:15:22Z",
71        "archived": true,
72        "externalId": "string",
73        "id": 0,
74        "cultureId": 0,
75        "value": "string"
76      }
77    ]
78  },
79  "customSheetList": [
80    "string"
81  ],
82  "currentSheetName": "string",
83  "runningExcelImportTasks": 0,
84  "processStatus": "NOT_STARTED",
85  "currentDataMergeStatusId": 0,
86  "update": true
87}

Download Import Result Report

HTTP Request

GET /api/excel-upload-histories/{id}/download-import-report

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

OK

StreamingResponseBody

Example Responses

1{}

Download Excel Upload History Document

HTTP Request

GET /api/excel-upload-histories/{id}/documents/{documentId}/download

📋 Description: Downloads the specified document associated with a particular Excel upload history, enabling users to access detailed analytics and insights related to their portfolio and asset management within the Nakisa Portfolio Management Suite.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

documentId

path

integer(int64)

true

Unique identifier for the document

Responses

Status

Meaning

Description

Schema

200

OK

OK

StreamingResponseBody

Example Responses

1{}