Document

Document - Get Document

HTTP Request

GET /api/documents/{documentId}

📋 Description: Fetches detailed information about a specific document identified by the documentId, enabling users to access critical data related to portfolio assets and analytics within the Nakisa Portfolio Management Suite.

Parameters

Name

In

Type

Required

Description

documentId

path

integer(int64)

true

Unique identifier for the document

Responses

Status

Meaning

Description

Schema

200

OK

OK

DocumentDto

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  "name": "string",
10  "title": "string",
11  "type": "string",
12  "description": "string",
13  "link": "string",
14  "signedDate": "2019-08-24",
15  "documentTypeId": 0,
16  "statusId": 0,
17  "shareable": true,
18  "size": 0,
19  "documentType": {
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  "status": {
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}

Document - Update Document

HTTP Request

PUT /api/documents/{documentId}

📋 Description: Updates the specified document in the Nakisa Portfolio Management Suite, allowing users to modify asset-related information and analytics for enhanced portfolio management and real estate property oversight.

Parameters

Name

In

Type

Required

Description

documentId

path

integer(int64)

true

Unique identifier for the document

body

body

DocumentDto

true

Request body containing the updated document details, including asset information and analytics relevant to the portfolio management of 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  "name": "string",
10  "title": "string",
11  "type": "string",
12  "description": "string",
13  "link": "string",
14  "signedDate": "2019-08-24",
15  "documentTypeId": 0,
16  "statusId": 0,
17  "shareable": true,
18  "size": 0,
19  "documentType": {
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  "status": {
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}

Responses

Status

Meaning

Description

Schema

200

OK

OK

DocumentDto

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  "name": "string",
10  "title": "string",
11  "type": "string",
12  "description": "string",
13  "link": "string",
14  "signedDate": "2019-08-24",
15  "documentTypeId": 0,
16  "statusId": 0,
17  "shareable": true,
18  "size": 0,
19  "documentType": {
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  "status": {
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}

Document - Stream Document

HTTP Request

POST /api/documents/{documentId}/download

Deprecated

This endpoint is deprecated and may be removed in a future version. Please use alternative endpoints if available.

📋 Description: Downloads the specified document associated with a portfolio asset, enabling users to access critical analytics and insights related to real estate properties.

Parameters

Name

In

Type

Required

Description

documentId

path

integer(int64)

true

Unique identifier for the document

Responses

Status

Meaning

Description

Schema

200

OK

OK

StreamingResponseBody

Example Responses

1{}

Document - Archive Document

HTTP Request

POST /api/documents/{documentId}/archive

📋 Description: Archives a specified document within the Nakisa Portfolio Management Suite, facilitating efficient document management and enhancing asset analytics for real estate properties.

Parameters

Name

In

Type

Required

Description

documentId

path

integer(int64)

true

Unique identifier for the document

Responses

Status

Meaning

Description

Schema

200

OK

OK

DocumentDto

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  "name": "string",
10  "title": "string",
11  "type": "string",
12  "description": "string",
13  "link": "string",
14  "signedDate": "2019-08-24",
15  "documentTypeId": 0,
16  "statusId": 0,
17  "shareable": true,
18  "size": 0,
19  "documentType": {
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  "status": {
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}

Document - Get Documents

HTTP Request

GET /api/documents

📋 Description: Retrieves a list of documents related to portfolio and asset management within the Nakisa Portfolio Management Suite, enabling users to access critical analytics for real estate properties.

Parameters

Name

In

Type

Required

Description

pageable

query

Pageable

true

Indicates whether the results of the document retrieval should be paginated, facilitating efficient access to portfolio and asset analytics within the Nakisa Portfolio Management Suite.

search

query

string

false

Search term used to filter and retrieve specific documents related to portfolio, asset, analytics, or real estate property within the Nakisa Portfolio Management Suite.

id

query

string

false

Unique identifier for the resource

status-id

query

string

false

Unique identifier for the status of a document within the Nakisa Portfolio Management Suite, facilitating effective tracking and management of portfolio, asset, and real estate property analytics.

signed-date

query

string

false

Specifies the date on which the document was signed, relevant for tracking portfolio and asset analytics within the Nakisa Portfolio Management Suite.

name

query

string

false

Name of the resource

title

query

string

false

Title of the resource

type

query

string

false

Type of the resource

shareable

query

string

false

Indicates whether the document is shareable within the Nakisa Portfolio Management Suite, facilitating collaboration on portfolio, asset, and real estate property analytics.

document-type-id

query

string

false

Unique identifier for the type of document being requested, essential for retrieving specific portfolio, asset, or real estate property analytics within the Nakisa Portfolio Management Suite.

document-type-id-in

query

string

false

Specifies the unique identifier for the type of document to filter results within the Nakisa Portfolio Management Suite, relevant to portfolio, asset, analytics, and real estate property contexts.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PagedModelEntityModelDocumentDto

Example Responses

 1{
 2  "_embedded": {
 3    "documents": [
 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        "name": "string",
13        "title": "string",
14        "type": "string",
15        "description": "string",
16        "link": "string",
17        "signedDate": "2019-08-24",
18        "documentTypeId": 0,
19        "statusId": 0,
20        "shareable": true,
21        "size": 0,
22        "documentType": {
23          "createdBy": "string",
24          "lastModifiedBy": "string",
25          "createdDate": "2019-08-24T14:15:22Z",
26          "lastModifiedDate": "2019-08-24T14:15:22Z",
27          "archived": true,
28          "externalId": "string",
29          "id": 0,
30          "priority": 0,
31          "internalId": 0,
32          "pickListCode": "string",
33          "pickListLabel": "string",
34          "label": "string",
35          "cultureId": 0,
36          "labelDtos": [
37            {
38              "createdBy": "string",
39              "lastModifiedBy": "string",
40              "createdDate": "2019-08-24T14:15:22Z",
41              "lastModifiedDate": "2019-08-24T14:15:22Z",
42              "archived": true,
43              "externalId": "string",
44              "id": 0,
45              "cultureId": 0,
46              "value": "string"
47            }
48          ]
49        },
50        "status": {
51          "createdBy": "string",
52          "lastModifiedBy": "string",
53          "createdDate": "2019-08-24T14:15:22Z",
54          "lastModifiedDate": "2019-08-24T14:15:22Z",
55          "archived": true,
56          "externalId": "string",
57          "id": 0,
58          "priority": 0,
59          "internalId": 0,
60          "pickListCode": "string",
61          "pickListLabel": "string",
62          "label": "string",
63          "cultureId": 0,
64          "labelDtos": [
65            {
66              "createdBy": "string",
67              "lastModifiedBy": "string",
68              "createdDate": "2019-08-24T14:15:22Z",
69              "lastModifiedDate": "2019-08-24T14:15:22Z",
70              "archived": true,
71              "externalId": "string",
72              "id": 0,
73              "cultureId": 0,
74              "value": "string"
75            }
76          ]
77        }
78      }
79    ]
80  },
81  "page": {
82    "size": 0,
83    "totalElements": 0,
84    "totalPages": 0,
85    "number": 0
86  }
87}