Subscription¶
Get Subscription¶
HTTP Request
GET /api/subscriptions/{id}
📋 Description: Retrieves detailed information about a specific subscription within the Nakisa Portfolio Management Suite, enabling users to analyze portfolio and asset performance 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 "topic": "string",
10 "subscriberUrl": "string",
11 "subscriptionAuthorization": "string",
12 "subscriptionAuthorizationDto": {
13 "authType": "string"
14 },
15 "authTypeValue": {
16 "createdBy": "string",
17 "lastModifiedBy": "string",
18 "createdDate": "2019-08-24T14:15:22Z",
19 "lastModifiedDate": "2019-08-24T14:15:22Z",
20 "archived": true,
21 "externalId": "string",
22 "id": 0,
23 "priority": 0,
24 "internalId": 0,
25 "pickListCode": "string",
26 "pickListLabel": "string",
27 "label": "string",
28 "cultureId": 0,
29 "labelDtos": [
30 {
31 "createdBy": "string",
32 "lastModifiedBy": "string",
33 "createdDate": "2019-08-24T14:15:22Z",
34 "lastModifiedDate": "2019-08-24T14:15:22Z",
35 "archived": true,
36 "externalId": "string",
37 "id": 0,
38 "cultureId": 0,
39 "value": "string"
40 }
41 ]
42 }
43}
Update Subscription¶
HTTP Request
PUT /api/subscriptions/{id}
📋 Description: Updates the subscription details for a specified portfolio asset within the Nakisa Portfolio Management Suite, enabling enhanced analytics and management of real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the subscription details, including portfolio identifiers, asset allocations, and analytics preferences for the specified real estate property. |
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 "topic": "string",
10 "subscriberUrl": "string",
11 "subscriptionAuthorization": "string",
12 "subscriptionAuthorizationDto": {
13 "authType": "string"
14 },
15 "authTypeValue": {
16 "createdBy": "string",
17 "lastModifiedBy": "string",
18 "createdDate": "2019-08-24T14:15:22Z",
19 "lastModifiedDate": "2019-08-24T14:15:22Z",
20 "archived": true,
21 "externalId": "string",
22 "id": 0,
23 "priority": 0,
24 "internalId": 0,
25 "pickListCode": "string",
26 "pickListLabel": "string",
27 "label": "string",
28 "cultureId": 0,
29 "labelDtos": [
30 {
31 "createdBy": "string",
32 "lastModifiedBy": "string",
33 "createdDate": "2019-08-24T14:15:22Z",
34 "lastModifiedDate": "2019-08-24T14:15:22Z",
35 "archived": true,
36 "externalId": "string",
37 "id": 0,
38 "cultureId": 0,
39 "value": "string"
40 }
41 ]
42 }
43}
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 "topic": "string",
10 "subscriberUrl": "string",
11 "subscriptionAuthorization": "string",
12 "subscriptionAuthorizationDto": {
13 "authType": "string"
14 },
15 "authTypeValue": {
16 "createdBy": "string",
17 "lastModifiedBy": "string",
18 "createdDate": "2019-08-24T14:15:22Z",
19 "lastModifiedDate": "2019-08-24T14:15:22Z",
20 "archived": true,
21 "externalId": "string",
22 "id": 0,
23 "priority": 0,
24 "internalId": 0,
25 "pickListCode": "string",
26 "pickListLabel": "string",
27 "label": "string",
28 "cultureId": 0,
29 "labelDtos": [
30 {
31 "createdBy": "string",
32 "lastModifiedBy": "string",
33 "createdDate": "2019-08-24T14:15:22Z",
34 "lastModifiedDate": "2019-08-24T14:15:22Z",
35 "archived": true,
36 "externalId": "string",
37 "id": 0,
38 "cultureId": 0,
39 "value": "string"
40 }
41 ]
42 }
43}
Delete Subscription¶
HTTP Request
DELETE /api/subscriptions/{id}
📋 Description: Deletes a specified subscription from the Nakisa Portfolio Management Suite, enabling users to manage their portfolio assets and analytics related to real estate properties effectively.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
204 |
No Content |
None |
Get Subscriptions¶
HTTP Request
GET /api/subscriptions
📋 Description: Retrieves a list of subscriptions related to portfolio management, enabling users to access and analyze asset and real estate property data effectively.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the response should be paginated, facilitating efficient retrieval of subscription data within the Nakisa Portfolio Management Suite for enhanced portfolio and asset analytics. |
|
topic |
query |
string |
false |
Specifies the subject matter of interest for retrieving subscription data related to portfolio, asset, analytics, or real estate property within the Nakisa Portfolio Management Suite. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "subscriptions": [
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 "topic": "string",
13 "subscriberUrl": "string",
14 "subscriptionAuthorization": "string",
15 "subscriptionAuthorizationDto": {
16 "authType": "string"
17 },
18 "authTypeValue": {
19 "createdBy": "string",
20 "lastModifiedBy": "string",
21 "createdDate": "2019-08-24T14:15:22Z",
22 "lastModifiedDate": "2019-08-24T14:15:22Z",
23 "archived": true,
24 "externalId": "string",
25 "id": 0,
26 "priority": 0,
27 "internalId": 0,
28 "pickListCode": "string",
29 "pickListLabel": "string",
30 "label": "string",
31 "cultureId": 0,
32 "labelDtos": [
33 {
34 "createdBy": "string",
35 "lastModifiedBy": "string",
36 "createdDate": "2019-08-24T14:15:22Z",
37 "lastModifiedDate": "2019-08-24T14:15:22Z",
38 "archived": true,
39 "externalId": "string",
40 "id": 0,
41 "cultureId": 0,
42 "value": "string"
43 }
44 ]
45 }
46 }
47 ]
48 },
49 "page": {
50 "size": 0,
51 "totalElements": 0,
52 "totalPages": 0,
53 "number": 0
54 }
55}
Create Entities¶
HTTP Request
POST /api/subscriptions
📋 Description: Creates a new subscription for portfolio analytics related to real estate properties, enabling users to access tailored insights and performance metrics.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing subscription details, including portfolio identifiers, asset selections, and analytics preferences for real estate property management. |
Body Parameters
1[
2 {
3 "createdBy": "string",
4 "lastModifiedBy": "string",
5 "createdDate": "2019-08-24T14:15:22Z",
6 "lastModifiedDate": "2019-08-24T14:15:22Z",
7 "archived": true,
8 "externalId": "string",
9 "id": 0,
10 "topic": "string",
11 "subscriberUrl": "string",
12 "subscriptionAuthorization": "string",
13 "subscriptionAuthorizationDto": {
14 "authType": "string"
15 },
16 "authTypeValue": {
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 }
45]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
Inline |
Example Responses
1[
2 {
3 "createdBy": "string",
4 "lastModifiedBy": "string",
5 "createdDate": "2019-08-24T14:15:22Z",
6 "lastModifiedDate": "2019-08-24T14:15:22Z",
7 "archived": true,
8 "externalId": "string",
9 "id": 0,
10 "topic": "string",
11 "subscriberUrl": "string",
12 "subscriptionAuthorization": "string",
13 "subscriptionAuthorizationDto": {
14 "authType": "string"
15 },
16 "authTypeValue": {
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 }
45]
Response Schema
Status Code 201
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a subscription within the Nakisa Portfolio Management Suite, encompassing essential details related to portfolio management, asset tracking, and analytics for real estate properties.] |
|
» createdBy |
string |
false |
none |
Username of who created this resource |
» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
» createdDate |
string(date-time) |
false |
none |
Date of the created |
» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
» externalId |
string |
false |
none |
Unique identifier for the external |
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» topic |
string |
true |
none |
Text value for topic in SubscriptionDto |
» subscriberUrl |
string |
true |
none |
Text value for subscriberUrl in SubscriptionDto |
» subscriptionAuthorization |
string(byte) |
false |
none |
Text value for subscriptionAuthorization in SubscriptionDto |
» subscriptionAuthorizationDto |
any |
false |
none |
Value for subscriptionAuthorizationDto field |
oneOf - discriminator: authType
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
false |
none |
Data transfer object representing the authorization details for subscription management within the Nakisa Portfolio Management Suite, facilitating access to portfolio analytics and real estate asset insights. |
|
»»» authType |
string |
true |
none |
Type of the auth |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
false |
none |
Data transfer object representing the authorization details for API key subscriptions within the Nakisa Portfolio Management Suite, facilitating secure access to portfolio, asset, analytics, and real estate property data. |
allOf - discriminator: authType
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
Data transfer object representing the authorization details for subscription management within the Nakisa Portfolio Management Suite, facilitating access to portfolio analytics and real estate asset insights. |
and
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
object |
false |
none |
none |
»»»» key |
string |
false |
none |
none |
»»»» value |
string |
false |
none |
none |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
false |
none |
Data transfer object representing the authorization details for a basic subscription within the Nakisa Portfolio Management Suite, facilitating access to portfolio, asset, and analytics data related to real estate properties. |
allOf - discriminator: authType
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
Data transfer object representing the authorization details for subscription management within the Nakisa Portfolio Management Suite, facilitating access to portfolio analytics and real estate asset insights. |
and
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
object |
false |
none |
none |
»»»» userName |
string |
false |
none |
none |
»»»» password |
string |
false |
none |
none |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
false |
none |
Data transfer object representing the authorization details for bearer token subscriptions within the Nakisa Portfolio Management Suite, facilitating secure access to portfolio, asset, and analytics data related to real estate properties. |
allOf - discriminator: authType
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
Data transfer object representing the authorization details for subscription management within the Nakisa Portfolio Management Suite, facilitating access to portfolio analytics and real estate asset insights. |
and
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
object |
false |
none |
none |
»»»» token |
string |
false |
none |
none |
xor - discriminator: authType
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
false |
none |
NoAuthSubscriptionAuthorizationDto is a data transfer object that encapsulates the authorization details for subscription access within the Nakisa Portfolio Management Suite, specifically tailored for portfolio, asset, analytics, and real estate property management. |
|
»»» authType |
string |
true |
none |
Type of the auth |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
false |
none |
Data transfer object representing the authorization details for OAuth subscriptions within the Nakisa Portfolio Management Suite, facilitating secure access to portfolio, asset, analytics, and real estate property data. |
allOf - discriminator: authType
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
Data transfer object representing the authorization details for subscription management within the Nakisa Portfolio Management Suite, facilitating access to portfolio analytics and real estate asset insights. |
and
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
object |
false |
none |
none |
»»»» tenantURL |
string |
false |
none |
none |
»»»» clientId |
string |
false |
none |
none |
»»»» clientSecret |
string |
false |
none |
none |
»»»» scope |
string |
false |
none |
none |
continued
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
» authTypeValue |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management. |
|
»» createdBy |
string |
false |
none |
Username of who created this resource |
»» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
»» createdDate |
string(date-time) |
false |
none |
Date of the created |
»» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
»» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
»» externalId |
string |
false |
none |
Unique identifier for the external |
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» priority |
integer(int64) |
false |
none |
Priority of the resource |
»» internalId |
integer(int64) |
false |
none |
Unique identifier for the internal |
»» pickListCode |
string |
false |
none |
Code for the pick list |
»» pickListLabel |
string |
false |
none |
Label for the pick list |
»» label |
string |
false |
none |
Label for the resource |
»» cultureId |
integer(int64) |
false |
none |
Unique identifier for the culture |
»» labelDtos |
false |
none |
List of labelDtos items |
|
»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
»»» createdDate |
string(date-time) |
false |
none |
Date of the created |
»»» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
»»» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
»»» externalId |
string |
false |
none |
Unique identifier for the external |
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» cultureId |
integer(int64) |
false |
none |
Unique identifier for the culture |
»»» value |
string |
true |
none |
Text value for value in LabelDto |
Subscribe To All¶
HTTP Request
POST /api/subscribe-all
📋 Description: Subscribes users to all relevant updates and notifications related to portfolio, asset, and analytics data within the Nakisa Portfolio Management Suite, enhancing real estate property management insights.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing subscription details for all portfolios and assets within the Nakisa Portfolio Management Suite, including relevant analytics and real estate property information. |
Body Parameters
1[
2 {
3 "createdBy": "string",
4 "lastModifiedBy": "string",
5 "createdDate": "2019-08-24T14:15:22Z",
6 "lastModifiedDate": "2019-08-24T14:15:22Z",
7 "archived": true,
8 "externalId": "string",
9 "id": 0,
10 "topic": "string",
11 "subscriberUrl": "string",
12 "subscriptionAuthorization": "string",
13 "subscriptionAuthorizationDto": {
14 "authType": "string"
15 },
16 "authTypeValue": {
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 }
45]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
Inline |
Example Responses
1[
2 {
3 "createdBy": "string",
4 "lastModifiedBy": "string",
5 "createdDate": "2019-08-24T14:15:22Z",
6 "lastModifiedDate": "2019-08-24T14:15:22Z",
7 "archived": true,
8 "externalId": "string",
9 "id": 0,
10 "topic": "string",
11 "subscriberUrl": "string",
12 "subscriptionAuthorization": "string",
13 "subscriptionAuthorizationDto": {
14 "authType": "string"
15 },
16 "authTypeValue": {
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 }
45]
Response Schema
Status Code 201
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a subscription within the Nakisa Portfolio Management Suite, encompassing essential details related to portfolio management, asset tracking, and analytics for real estate properties.] |
|
» createdBy |
string |
false |
none |
Username of who created this resource |
» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
» createdDate |
string(date-time) |
false |
none |
Date of the created |
» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
» externalId |
string |
false |
none |
Unique identifier for the external |
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» topic |
string |
true |
none |
Text value for topic in SubscriptionDto |
» subscriberUrl |
string |
true |
none |
Text value for subscriberUrl in SubscriptionDto |
» subscriptionAuthorization |
string(byte) |
false |
none |
Text value for subscriptionAuthorization in SubscriptionDto |
» subscriptionAuthorizationDto |
any |
false |
none |
Value for subscriptionAuthorizationDto field |
oneOf - discriminator: authType
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
false |
none |
Data transfer object representing the authorization details for subscription management within the Nakisa Portfolio Management Suite, facilitating access to portfolio analytics and real estate asset insights. |
|
»»» authType |
string |
true |
none |
Type of the auth |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
false |
none |
Data transfer object representing the authorization details for API key subscriptions within the Nakisa Portfolio Management Suite, facilitating secure access to portfolio, asset, analytics, and real estate property data. |
allOf - discriminator: authType
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
Data transfer object representing the authorization details for subscription management within the Nakisa Portfolio Management Suite, facilitating access to portfolio analytics and real estate asset insights. |
and
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
object |
false |
none |
none |
»»»» key |
string |
false |
none |
none |
»»»» value |
string |
false |
none |
none |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
false |
none |
Data transfer object representing the authorization details for a basic subscription within the Nakisa Portfolio Management Suite, facilitating access to portfolio, asset, and analytics data related to real estate properties. |
allOf - discriminator: authType
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
Data transfer object representing the authorization details for subscription management within the Nakisa Portfolio Management Suite, facilitating access to portfolio analytics and real estate asset insights. |
and
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
object |
false |
none |
none |
»»»» userName |
string |
false |
none |
none |
»»»» password |
string |
false |
none |
none |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
false |
none |
Data transfer object representing the authorization details for bearer token subscriptions within the Nakisa Portfolio Management Suite, facilitating secure access to portfolio, asset, and analytics data related to real estate properties. |
allOf - discriminator: authType
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
Data transfer object representing the authorization details for subscription management within the Nakisa Portfolio Management Suite, facilitating access to portfolio analytics and real estate asset insights. |
and
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
object |
false |
none |
none |
»»»» token |
string |
false |
none |
none |
xor - discriminator: authType
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
false |
none |
NoAuthSubscriptionAuthorizationDto is a data transfer object that encapsulates the authorization details for subscription access within the Nakisa Portfolio Management Suite, specifically tailored for portfolio, asset, analytics, and real estate property management. |
|
»»» authType |
string |
true |
none |
Type of the auth |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»» anonymous |
false |
none |
Data transfer object representing the authorization details for OAuth subscriptions within the Nakisa Portfolio Management Suite, facilitating secure access to portfolio, asset, analytics, and real estate property data. |
allOf - discriminator: authType
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
false |
none |
Data transfer object representing the authorization details for subscription management within the Nakisa Portfolio Management Suite, facilitating access to portfolio analytics and real estate asset insights. |
and
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» anonymous |
object |
false |
none |
none |
»»»» tenantURL |
string |
false |
none |
none |
»»»» clientId |
string |
false |
none |
none |
»»»» clientSecret |
string |
false |
none |
none |
»»»» scope |
string |
false |
none |
none |
continued
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
» authTypeValue |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management. |
|
»» createdBy |
string |
false |
none |
Username of who created this resource |
»» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
»» createdDate |
string(date-time) |
false |
none |
Date of the created |
»» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
»» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
»» externalId |
string |
false |
none |
Unique identifier for the external |
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» priority |
integer(int64) |
false |
none |
Priority of the resource |
»» internalId |
integer(int64) |
false |
none |
Unique identifier for the internal |
»» pickListCode |
string |
false |
none |
Code for the pick list |
»» pickListLabel |
string |
false |
none |
Label for the pick list |
»» label |
string |
false |
none |
Label for the resource |
»» cultureId |
integer(int64) |
false |
none |
Unique identifier for the culture |
»» labelDtos |
false |
none |
List of labelDtos items |
|
»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
»»» createdDate |
string(date-time) |
false |
none |
Date of the created |
»»» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
»»» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
»»» externalId |
string |
false |
none |
Unique identifier for the external |
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» cultureId |
integer(int64) |
false |
none |
Unique identifier for the culture |
»»» value |
string |
true |
none |
Text value for value in LabelDto |
Get Subscribable Topics¶
HTTP Request
GET /api/topics
📋 Description: Retrieves a comprehensive list of topics related to portfolio management, asset analytics, and real estate properties, enabling users to gain insights and make informed decisions.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 "string"
3]