Excel Template¶
Stream Custom Excel Templates¶
HTTP Request
POST /api/excel-template-download/{id}/custom-download
📋 Description: Facilitates the custom download of an Excel template for a specified portfolio asset, enabling users to tailor analytics and reporting for real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
includeSample |
query |
boolean |
true |
Specifies whether to include sample data in the custom Excel template download for portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
body |
body |
true |
Request body containing the parameters for customizing the Excel template download for a specific portfolio asset, including filters and analytics preferences. |
Body Parameters
1[
2 {
3 "entityName": "string",
4 "sheetNames": [
5 "string"
6 ],
7 "dependencyMap": {
8 "property1": [
9 "string"
10 ],
11 "property2": [
12 "string"
13 ]
14 }
15 }
16]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Get Sheet Options¶
HTTP Request
GET /api/excel-template/{id}/sheets
📋 Description: Retrieves the list of sheets associated with a specified Excel template in the Nakisa Portfolio Management Suite, enabling users to analyze and manage portfolio and asset data effectively.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 {
3 "entityName": "string",
4 "sheetNames": [
5 "string"
6 ],
7 "dependencyMap": {
8 "property1": [
9 "string"
10 ],
11 "property2": [
12 "string"
13 ]
14 }
15 }
16]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data structure representing a customizable template for entity sheets within the Nakisa Portfolio Management Suite, facilitating the organization and analysis of portfolio assets and real estate properties.] |
|
» entityName |
string |
false |
none |
Name of the entity |
» sheetNames |
[string] |
false |
none |
List of sheetNames items |
» dependencyMap |
object |
false |
none |
Object containing dependencyMap details |
»» additionalProperties |
[string] |
false |
none |
none |
Stream Excel Template¶
HTTP Request
GET /api/excel-template-download/{id}/download
📋 Description: Downloads the specified Excel template for portfolio analytics related to real estate properties, identified by the unique template ID.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
includeSample |
query |
boolean |
true |
Specifies whether to include sample data in the Excel template download for the specified portfolio asset, enhancing analytics capabilities within the Nakisa Portfolio Management Suite. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{}