Reference

Reference - Get Reference

HTTP Request

GET /api/references/{id}

Interactive Demo

📋 Description: Retrieves detailed information about a specific asset reference within the Nakisa Portfolio Management Suite, enabling users to analyze portfolio data and enhance decision-making 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	OK	ReferenceDto

Example Responses

{
  "createdBy": "string",
  "lastModifiedBy": "string",
  "createdDate": "2019-08-24T14:15:22Z",
  "lastModifiedDate": "2019-08-24T14:15:22Z",
  "archived": true,
  "externalId": "string",
  "id": 0,
  "number": "string",
  "departmentId": 0,
  "department": {
    "createdBy": "string",
    "lastModifiedBy": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "lastModifiedDate": "2019-08-24T14:15:22Z",
    "archived": true,
    "externalId": "string",
    "id": 0,
    "priority": 0,
    "internalId": 0,
    "pickListCode": "string",
    "pickListLabel": "string",
    "label": "string",
    "cultureId": 0,
    "labelDtos": [
      {
        "createdBy": "string",
        "lastModifiedBy": "string",
        "createdDate": "2019-08-24T14:15:22Z",
        "lastModifiedDate": "2019-08-24T14:15:22Z",
        "archived": true,
        "externalId": "string",
        "id": 0,
        "cultureId": 0,
        "value": "string"
      }
    ]
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Reference - Update Reference

HTTP Request

PUT /api/references/{id}

Interactive Demo

📋 Description: Updates the details of a specific reference asset within the Nakisa Portfolio Management Suite, enabling users to maintain accurate and current information related to portfolios, assets, and real estate properties.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	ReferenceDto	true	Request body containing the updated portfolio asset details, including analytics metrics and real estate property attributes, for the specified reference ID.

Body Parameters

{
  "createdBy": "string",
  "lastModifiedBy": "string",
  "createdDate": "2019-08-24T14:15:22Z",
  "lastModifiedDate": "2019-08-24T14:15:22Z",
  "archived": true,
  "externalId": "string",
  "id": 0,
  "number": "string",
  "departmentId": 0,
  "department": {
    "createdBy": "string",
    "lastModifiedBy": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "lastModifiedDate": "2019-08-24T14:15:22Z",
    "archived": true,
    "externalId": "string",
    "id": 0,
    "priority": 0,
    "internalId": 0,
    "pickListCode": "string",
    "pickListLabel": "string",
    "label": "string",
    "cultureId": 0,
    "labelDtos": [
      {
        "createdBy": "string",
        "lastModifiedBy": "string",
        "createdDate": "2019-08-24T14:15:22Z",
        "lastModifiedDate": "2019-08-24T14:15:22Z",
        "archived": true,
        "externalId": "string",
        "id": 0,
        "cultureId": 0,
        "value": "string"
      }
    ]
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ReferenceDto

Example Responses

{
  "createdBy": "string",
  "lastModifiedBy": "string",
  "createdDate": "2019-08-24T14:15:22Z",
  "lastModifiedDate": "2019-08-24T14:15:22Z",
  "archived": true,
  "externalId": "string",
  "id": 0,
  "number": "string",
  "departmentId": 0,
  "department": {
    "createdBy": "string",
    "lastModifiedBy": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "lastModifiedDate": "2019-08-24T14:15:22Z",
    "archived": true,
    "externalId": "string",
    "id": 0,
    "priority": 0,
    "internalId": 0,
    "pickListCode": "string",
    "pickListLabel": "string",
    "label": "string",
    "cultureId": 0,
    "labelDtos": [
      {
        "createdBy": "string",
        "lastModifiedBy": "string",
        "createdDate": "2019-08-24T14:15:22Z",
        "lastModifiedDate": "2019-08-24T14:15:22Z",
        "archived": true,
        "externalId": "string",
        "id": 0,
        "cultureId": 0,
        "value": "string"
      }
    ]
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Reference - Delete Reference

HTTP Request

DELETE /api/references/{id}

Interactive Demo

📋 Description: Deletes a specified reference asset from the Nakisa Portfolio Management Suite, ensuring the integrity and accuracy of portfolio 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
204	No Content	No Content	None

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Reference - Get References

HTTP Request

GET /api/references

Interactive Demo

📋 Description: Retrieves a comprehensive list of references related to portfolios, assets, and real estate properties within the Nakisa Portfolio Management Suite, enabling users to access essential analytics for informed decision-making.

Parameters

Name	In	Type	Required	Description
pageable	query	Pageable	true	Indicates whether the results of the asset references query should be returned in a paginated format, facilitating efficient data retrieval for portfolio and real estate property analytics.
search	query	string	false	Search term used to filter and retrieve specific portfolio, asset, or real estate property references within the Nakisa Portfolio Management Suite.
number	query	string	false	Specifies the unique identifier for a portfolio or asset within the Nakisa Portfolio Management Suite, facilitating targeted analytics and insights for real estate properties.
department-id	query	string	false	Unique identifier for the department within the Nakisa Portfolio Management Suite, used to filter and retrieve relevant portfolio, asset, and analytics data related to real estate properties.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PagedModelEntityModelReferenceDto

Example Responses

{
  "_embedded": {
    "references": [
      {
        "createdBy": "string",
        "lastModifiedBy": "string",
        "createdDate": "2019-08-24T14:15:22Z",
        "lastModifiedDate": "2019-08-24T14:15:22Z",
        "archived": true,
        "externalId": "string",
        "id": 0,
        "number": "string",
        "departmentId": 0,
        "department": {
          "createdBy": "string",
          "lastModifiedBy": "string",
          "createdDate": "2019-08-24T14:15:22Z",
          "lastModifiedDate": "2019-08-24T14:15:22Z",
          "archived": true,
          "externalId": "string",
          "id": 0,
          "priority": 0,
          "internalId": 0,
          "pickListCode": "string",
          "pickListLabel": "string",
          "label": "string",
          "cultureId": 0,
          "labelDtos": [
            {
              "createdBy": "string",
              "lastModifiedBy": "string",
              "createdDate": "2019-08-24T14:15:22Z",
              "lastModifiedDate": "2019-08-24T14:15:22Z",
              "archived": true,
              "externalId": "string",
              "id": 0,
              "cultureId": 0,
              "value": "string"
            }
          ]
        }
      }
    ]
  },
  "page": {
    "size": 0,
    "totalElements": 0,
    "totalPages": 0,
    "number": 0
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Reference - Create References

HTTP Request

POST /api/references

Interactive Demo

📋 Description: Creates a new reference entry within the Nakisa Portfolio Management Suite, enabling users to manage and analyze portfolio assets related to real estate properties effectively.

Parameters

Name	In	Type	Required	Description
body	body	ReferenceDto	true	Request body containing portfolio reference data, including asset details and analytics relevant to real estate properties.

Body Parameters

[
  {
    "createdBy": "string",
    "lastModifiedBy": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "lastModifiedDate": "2019-08-24T14:15:22Z",
    "archived": true,
    "externalId": "string",
    "id": 0,
    "number": "string",
    "departmentId": 0,
    "department": {
      "createdBy": "string",
      "lastModifiedBy": "string",
      "createdDate": "2019-08-24T14:15:22Z",
      "lastModifiedDate": "2019-08-24T14:15:22Z",
      "archived": true,
      "externalId": "string",
      "id": 0,
      "priority": 0,
      "internalId": 0,
      "pickListCode": "string",
      "pickListLabel": "string",
      "label": "string",
      "cultureId": 0,
      "labelDtos": [
        {
          "createdBy": "string",
          "lastModifiedBy": "string",
          "createdDate": "2019-08-24T14:15:22Z",
          "lastModifiedDate": "2019-08-24T14:15:22Z",
          "archived": true,
          "externalId": "string",
          "id": 0,
          "cultureId": 0,
          "value": "string"
        }
      ]
    }
  }
]

Responses

Status	Meaning	Description	Schema
201	Created	Created	Inline

Example Responses

[
  {
    "createdBy": "string",
    "lastModifiedBy": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "lastModifiedDate": "2019-08-24T14:15:22Z",
    "archived": true,
    "externalId": "string",
    "id": 0,
    "number": "string",
    "departmentId": 0,
    "department": {
      "createdBy": "string",
      "lastModifiedBy": "string",
      "createdDate": "2019-08-24T14:15:22Z",
      "lastModifiedDate": "2019-08-24T14:15:22Z",
      "archived": true,
      "externalId": "string",
      "id": 0,
      "priority": 0,
      "internalId": 0,
      "pickListCode": "string",
      "pickListLabel": "string",
      "label": "string",
      "cultureId": 0,
      "labelDtos": [
        {
          "createdBy": "string",
          "lastModifiedBy": "string",
          "createdDate": "2019-08-24T14:15:22Z",
          "lastModifiedDate": "2019-08-24T14:15:22Z",
          "archived": true,
          "externalId": "string",
          "id": 0,
          "cultureId": 0,
          "value": "string"
        }
      ]
    }
  }
]

Response Schema

Status Code 201

Name	Type	Required	Restrictions	Description
anonymous	[ReferenceDto]	false	none	[Data transfer object representing a reference entity within the Nakisa Portfolio Management Suite, encompassing key attributes related to portfolio, asset, analytics, and 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
» number	string	true	none	Represents a unique identifier for assets within the Nakisa Portfolio Management Suite, facilitating effective tracking and analytics in portfolio and real estate property management.
» departmentId	integer(int64)	false	none	Unique identifier for the department
» department	PickListOptionDto	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	[LabelDto]	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	Represents the descriptive value associated with a portfolio asset, facilitating analytics and insights within the Nakisa Portfolio Management Suite.

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Reference - Get Reference Notes

HTTP Request

GET /api/references/{id}/notes

Interactive Demo

📋 Description: Retrieves notes associated with a specific reference in the Nakisa Portfolio Management Suite, providing insights into portfolio and asset analytics for real estate properties.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
pageable	query	Pageable	true	Indicates whether the results of the notes associated with a specific portfolio asset should be returned in a paginated format, enhancing the efficiency of data retrieval in the Nakisa Portfolio Management Suite.
search	query	string	false	Search term used to filter notes related to a specific portfolio asset within the Nakisa Portfolio Management Suite.
message	query	string	false	Textual content of the note associated with the specified reference in the Nakisa Portfolio Management Suite, relevant for portfolio and asset analytics.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PagedModelEntityModelNoteDto

Example Responses

{
  "_embedded": {
    "notes": [
      {
        "createdBy": "string",
        "lastModifiedBy": "string",
        "createdDate": "2019-08-24T14:15:22Z",
        "lastModifiedDate": "2019-08-24T14:15:22Z",
        "archived": true,
        "externalId": "string",
        "id": 0,
        "message": "string",
        "userIds": [
          0
        ],
        "redirectUrl": "string"
      }
    ]
  },
  "page": {
    "size": 0,
    "totalElements": 0,
    "totalPages": 0,
    "number": 0
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Reference - Create Reference Notes

HTTP Request

POST /api/references/{id}/notes

Interactive Demo

📋 Description: Creates a new note associated with a specified reference in the Nakisa Portfolio Management Suite, enabling users to enhance portfolio and asset analytics for real estate properties.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	NoteDto	true	Request body containing the notes related to a specific portfolio asset, including details such as content, author, and timestamp for effective real estate property analytics.

Body Parameters

[
  {
    "createdBy": "string",
    "lastModifiedBy": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "lastModifiedDate": "2019-08-24T14:15:22Z",
    "archived": true,
    "externalId": "string",
    "id": 0,
    "message": "string",
    "userIds": [
      0
    ],
    "redirectUrl": "string"
  }
]

Responses

Status	Meaning	Description	Schema
201	Created	Created	Inline

Example Responses

[
  {
    "createdBy": "string",
    "lastModifiedBy": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "lastModifiedDate": "2019-08-24T14:15:22Z",
    "archived": true,
    "externalId": "string",
    "id": 0,
    "message": "string",
    "userIds": [
      0
    ],
    "redirectUrl": "string"
  }
]

Response Schema

Status Code 201

Name	Type	Required	Restrictions	Description
anonymous	[NoteDto]	false	none	[Data transfer object representing a note associated with portfolio management, asset analytics, and real estate properties, facilitating effective communication and documentation within the Nakisa Portfolio Management Suite.]
» 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
» message	string	true	none	Textual content providing detailed information or commentary related to the portfolio, asset, or real estate property within the Nakisa Portfolio Management Suite.
» userIds	[integer]	false	none	User information related to portfolio management
» redirectUrl	string	false	none	URL to which users will be redirected after completing a specific action within the Nakisa Portfolio Management Suite, facilitating seamless navigation in the context of portfolio, asset, and real estate property management.

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Reference - Archive Reference

HTTP Request

POST /api/references/{id}/archive

Interactive Demo

📋 Description: Archives a specified reference asset within the Nakisa Portfolio Management Suite, facilitating streamlined portfolio management and enhancing analytics for 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	OK	ReferenceDto

Example Responses

{
  "createdBy": "string",
  "lastModifiedBy": "string",
  "createdDate": "2019-08-24T14:15:22Z",
  "lastModifiedDate": "2019-08-24T14:15:22Z",
  "archived": true,
  "externalId": "string",
  "id": 0,
  "number": "string",
  "departmentId": 0,
  "department": {
    "createdBy": "string",
    "lastModifiedBy": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "lastModifiedDate": "2019-08-24T14:15:22Z",
    "archived": true,
    "externalId": "string",
    "id": 0,
    "priority": 0,
    "internalId": 0,
    "pickListCode": "string",
    "pickListLabel": "string",
    "label": "string",
    "cultureId": 0,
    "labelDtos": [
      {
        "createdBy": "string",
        "lastModifiedBy": "string",
        "createdDate": "2019-08-24T14:15:22Z",
        "lastModifiedDate": "2019-08-24T14:15:22Z",
        "archived": true,
        "externalId": "string",
        "id": 0,
        "cultureId": 0,
        "value": "string"
      }
    ]
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

---