Excel Export History¶
Excel Export History - Get Excel Import Export Histories¶
HTTP Request
GET /api/excel-export-histories
📋 Description: Retrieves the history of Excel export operations related to portfolio and asset analytics within the Nakisa Portfolio Management Suite, enabling users to track and manage real estate property data exports efficiently.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the results of the Excel export histories should be returned in a paginated format, facilitating efficient data retrieval for portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
|
document-id |
query |
string |
false |
Unique identifier for the document associated with the Excel export history, facilitating tracking and retrieval of portfolio, asset, and real estate property analytics. |
data-merge-type-id-in |
query |
string |
false |
Identifier for the data merge type used in the Excel export history retrieval, relevant for portfolio, asset, analytics, and real estate property management. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "excelExportHistories": [
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 "dataMergeType": {
20 "createdBy": "string",
21 "lastModifiedBy": "string",
22 "createdDate": "2019-08-24T14:15:22Z",
23 "lastModifiedDate": "2019-08-24T14:15:22Z",
24 "archived": true,
25 "externalId": "string",
26 "id": 0,
27 "priority": 0,
28 "internalId": 0,
29 "pickListCode": "string",
30 "pickListLabel": "string",
31 "label": "string",
32 "cultureId": 0,
33 "labelDtos": [
34 {
35 "createdBy": "string",
36 "lastModifiedBy": "string",
37 "createdDate": "2019-08-24T14:15:22Z",
38 "lastModifiedDate": "2019-08-24T14:15:22Z",
39 "archived": true,
40 "externalId": "string",
41 "id": 0,
42 "cultureId": 0,
43 "value": "string"
44 }
45 ]
46 },
47 "dataMergeStatus": {
48 "createdBy": "string",
49 "lastModifiedBy": "string",
50 "createdDate": "2019-08-24T14:15:22Z",
51 "lastModifiedDate": "2019-08-24T14:15:22Z",
52 "archived": true,
53 "externalId": "string",
54 "id": 0,
55 "priority": 0,
56 "internalId": 0,
57 "pickListCode": "string",
58 "pickListLabel": "string",
59 "label": "string",
60 "cultureId": 0,
61 "labelDtos": [
62 {
63 "createdBy": "string",
64 "lastModifiedBy": "string",
65 "createdDate": "2019-08-24T14:15:22Z",
66 "lastModifiedDate": "2019-08-24T14:15:22Z",
67 "archived": true,
68 "externalId": "string",
69 "id": 0,
70 "cultureId": 0,
71 "value": "string"
72 }
73 ]
74 },
75 "optionInternalIds": [
76 0
77 ],
78 "entityId": 0,
79 "reportType": "BATCH",
80 "inputs": {
81 "property1": {},
82 "property2": {}
83 },
84 "profileIds": [
85 0
86 ]
87 }
88 ]
89 },
90 "page": {
91 "size": 0,
92 "totalElements": 0,
93 "totalPages": 0,
94 "number": 0
95 }
96}
Excel Export History - Create Excel Export History¶
HTTP Request
POST /api/excel-export-histories
📋 Description: Creates a new record of Excel export history for portfolio analytics, enabling users to track and manage asset data related to real estate properties within the Nakisa Portfolio Management Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the parameters for generating an Excel export of portfolio and asset analytics related to real estate properties. |
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 "dataMergeType": {
17 "createdBy": "string",
18 "lastModifiedBy": "string",
19 "createdDate": "2019-08-24T14:15:22Z",
20 "lastModifiedDate": "2019-08-24T14:15:22Z",
21 "archived": true,
22 "externalId": "string",
23 "id": 0,
24 "priority": 0,
25 "internalId": 0,
26 "pickListCode": "string",
27 "pickListLabel": "string",
28 "label": "string",
29 "cultureId": 0,
30 "labelDtos": [
31 {
32 "createdBy": "string",
33 "lastModifiedBy": "string",
34 "createdDate": "2019-08-24T14:15:22Z",
35 "lastModifiedDate": "2019-08-24T14:15:22Z",
36 "archived": true,
37 "externalId": "string",
38 "id": 0,
39 "cultureId": 0,
40 "value": "string"
41 }
42 ]
43 },
44 "dataMergeStatus": {
45 "createdBy": "string",
46 "lastModifiedBy": "string",
47 "createdDate": "2019-08-24T14:15:22Z",
48 "lastModifiedDate": "2019-08-24T14:15:22Z",
49 "archived": true,
50 "externalId": "string",
51 "id": 0,
52 "priority": 0,
53 "internalId": 0,
54 "pickListCode": "string",
55 "pickListLabel": "string",
56 "label": "string",
57 "cultureId": 0,
58 "labelDtos": [
59 {
60 "createdBy": "string",
61 "lastModifiedBy": "string",
62 "createdDate": "2019-08-24T14:15:22Z",
63 "lastModifiedDate": "2019-08-24T14:15:22Z",
64 "archived": true,
65 "externalId": "string",
66 "id": 0,
67 "cultureId": 0,
68 "value": "string"
69 }
70 ]
71 },
72 "optionInternalIds": [
73 0
74 ],
75 "entityId": 0,
76 "reportType": "BATCH",
77 "inputs": {
78 "property1": {},
79 "property2": {}
80 },
81 "profileIds": [
82 0
83 ]
84}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
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 "dataMergeType": {
17 "createdBy": "string",
18 "lastModifiedBy": "string",
19 "createdDate": "2019-08-24T14:15:22Z",
20 "lastModifiedDate": "2019-08-24T14:15:22Z",
21 "archived": true,
22 "externalId": "string",
23 "id": 0,
24 "priority": 0,
25 "internalId": 0,
26 "pickListCode": "string",
27 "pickListLabel": "string",
28 "label": "string",
29 "cultureId": 0,
30 "labelDtos": [
31 {
32 "createdBy": "string",
33 "lastModifiedBy": "string",
34 "createdDate": "2019-08-24T14:15:22Z",
35 "lastModifiedDate": "2019-08-24T14:15:22Z",
36 "archived": true,
37 "externalId": "string",
38 "id": 0,
39 "cultureId": 0,
40 "value": "string"
41 }
42 ]
43 },
44 "dataMergeStatus": {
45 "createdBy": "string",
46 "lastModifiedBy": "string",
47 "createdDate": "2019-08-24T14:15:22Z",
48 "lastModifiedDate": "2019-08-24T14:15:22Z",
49 "archived": true,
50 "externalId": "string",
51 "id": 0,
52 "priority": 0,
53 "internalId": 0,
54 "pickListCode": "string",
55 "pickListLabel": "string",
56 "label": "string",
57 "cultureId": 0,
58 "labelDtos": [
59 {
60 "createdBy": "string",
61 "lastModifiedBy": "string",
62 "createdDate": "2019-08-24T14:15:22Z",
63 "lastModifiedDate": "2019-08-24T14:15:22Z",
64 "archived": true,
65 "externalId": "string",
66 "id": 0,
67 "cultureId": 0,
68 "value": "string"
69 }
70 ]
71 },
72 "optionInternalIds": [
73 0
74 ],
75 "entityId": 0,
76 "reportType": "BATCH",
77 "inputs": {
78 "property1": {},
79 "property2": {}
80 },
81 "profileIds": [
82 0
83 ]
84}
Excel Export History - Archive Excel Export History¶
HTTP Request
POST /api/excel-export-histories/{id}/archive
📋 Description: Archives the specified Excel export history for a portfolio asset within the Nakisa Portfolio Management Suite, enabling efficient management and retrieval of historical analytics related to real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
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 "dataMergeType": {
17 "createdBy": "string",
18 "lastModifiedBy": "string",
19 "createdDate": "2019-08-24T14:15:22Z",
20 "lastModifiedDate": "2019-08-24T14:15:22Z",
21 "archived": true,
22 "externalId": "string",
23 "id": 0,
24 "priority": 0,
25 "internalId": 0,
26 "pickListCode": "string",
27 "pickListLabel": "string",
28 "label": "string",
29 "cultureId": 0,
30 "labelDtos": [
31 {
32 "createdBy": "string",
33 "lastModifiedBy": "string",
34 "createdDate": "2019-08-24T14:15:22Z",
35 "lastModifiedDate": "2019-08-24T14:15:22Z",
36 "archived": true,
37 "externalId": "string",
38 "id": 0,
39 "cultureId": 0,
40 "value": "string"
41 }
42 ]
43 },
44 "dataMergeStatus": {
45 "createdBy": "string",
46 "lastModifiedBy": "string",
47 "createdDate": "2019-08-24T14:15:22Z",
48 "lastModifiedDate": "2019-08-24T14:15:22Z",
49 "archived": true,
50 "externalId": "string",
51 "id": 0,
52 "priority": 0,
53 "internalId": 0,
54 "pickListCode": "string",
55 "pickListLabel": "string",
56 "label": "string",
57 "cultureId": 0,
58 "labelDtos": [
59 {
60 "createdBy": "string",
61 "lastModifiedBy": "string",
62 "createdDate": "2019-08-24T14:15:22Z",
63 "lastModifiedDate": "2019-08-24T14:15:22Z",
64 "archived": true,
65 "externalId": "string",
66 "id": 0,
67 "cultureId": 0,
68 "value": "string"
69 }
70 ]
71 },
72 "optionInternalIds": [
73 0
74 ],
75 "entityId": 0,
76 "reportType": "BATCH",
77 "inputs": {
78 "property1": {},
79 "property2": {}
80 },
81 "profileIds": [
82 0
83 ]
84}
Excel Export History - Get Excel Export History¶
HTTP Request
GET /api/excel-export-histories/{id}
📋 Description: Retrieves the export history details for a specific Excel report identified by the provided ID, facilitating insights into portfolio and asset analytics 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 |
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 "dataMergeType": {
17 "createdBy": "string",
18 "lastModifiedBy": "string",
19 "createdDate": "2019-08-24T14:15:22Z",
20 "lastModifiedDate": "2019-08-24T14:15:22Z",
21 "archived": true,
22 "externalId": "string",
23 "id": 0,
24 "priority": 0,
25 "internalId": 0,
26 "pickListCode": "string",
27 "pickListLabel": "string",
28 "label": "string",
29 "cultureId": 0,
30 "labelDtos": [
31 {
32 "createdBy": "string",
33 "lastModifiedBy": "string",
34 "createdDate": "2019-08-24T14:15:22Z",
35 "lastModifiedDate": "2019-08-24T14:15:22Z",
36 "archived": true,
37 "externalId": "string",
38 "id": 0,
39 "cultureId": 0,
40 "value": "string"
41 }
42 ]
43 },
44 "dataMergeStatus": {
45 "createdBy": "string",
46 "lastModifiedBy": "string",
47 "createdDate": "2019-08-24T14:15:22Z",
48 "lastModifiedDate": "2019-08-24T14:15:22Z",
49 "archived": true,
50 "externalId": "string",
51 "id": 0,
52 "priority": 0,
53 "internalId": 0,
54 "pickListCode": "string",
55 "pickListLabel": "string",
56 "label": "string",
57 "cultureId": 0,
58 "labelDtos": [
59 {
60 "createdBy": "string",
61 "lastModifiedBy": "string",
62 "createdDate": "2019-08-24T14:15:22Z",
63 "lastModifiedDate": "2019-08-24T14:15:22Z",
64 "archived": true,
65 "externalId": "string",
66 "id": 0,
67 "cultureId": 0,
68 "value": "string"
69 }
70 ]
71 },
72 "optionInternalIds": [
73 0
74 ],
75 "entityId": 0,
76 "reportType": "BATCH",
77 "inputs": {
78 "property1": {},
79 "property2": {}
80 },
81 "profileIds": [
82 0
83 ]
84}
Excel Export History - Download Excel Export History Document¶
HTTP Request
GET /api/excel-export-histories/{id}/documents/{documentId}/download
📋 Description: Downloads the specified document associated with the Excel export history for a given portfolio asset, facilitating access to critical analytics data 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 |
Example Responses
1{}