Appeal

Get Appeal

HTTP Request

GET /api/appeals/{id}

📋 Description: Retrieves detailed information about a specific appeal within the Nakisa Portfolio Management Suite, enabling users to analyze portfolio and asset performance in the context of 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

AppealDto

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  "appealAssessmentId": 0,
 10  "appealReviewedId": 0,
 11  "appealed": true,
 12  "appealActionId": 0,
 13  "followUpDate": "2019-08-24",
 14  "targetedAssessment": 0,
 15  "revisedAssessment": 0,
 16  "appealNegotiationId": 0,
 17  "settlementDate": "2019-08-24",
 18  "note": "string",
 19  "savings": [
 20    {
 21      "year": 0,
 22      "savings": 0
 23    }
 24  ],
 25  "assessmentId": 0,
 26  "assessmentExternalId": "string",
 27  "appealAssessment": {
 28    "createdBy": "string",
 29    "lastModifiedBy": "string",
 30    "createdDate": "2019-08-24T14:15:22Z",
 31    "lastModifiedDate": "2019-08-24T14:15:22Z",
 32    "archived": true,
 33    "externalId": "string",
 34    "id": 0,
 35    "priority": 0,
 36    "internalId": 0,
 37    "pickListCode": "string",
 38    "pickListLabel": "string",
 39    "label": "string",
 40    "cultureId": 0,
 41    "labelDtos": [
 42      {
 43        "createdBy": "string",
 44        "lastModifiedBy": "string",
 45        "createdDate": "2019-08-24T14:15:22Z",
 46        "lastModifiedDate": "2019-08-24T14:15:22Z",
 47        "archived": true,
 48        "externalId": "string",
 49        "id": 0,
 50        "cultureId": 0,
 51        "value": "string"
 52      }
 53    ]
 54  },
 55  "appealReviewed": {
 56    "createdBy": "string",
 57    "lastModifiedBy": "string",
 58    "createdDate": "2019-08-24T14:15:22Z",
 59    "lastModifiedDate": "2019-08-24T14:15:22Z",
 60    "archived": true,
 61    "externalId": "string",
 62    "id": 0,
 63    "priority": 0,
 64    "internalId": 0,
 65    "pickListCode": "string",
 66    "pickListLabel": "string",
 67    "label": "string",
 68    "cultureId": 0,
 69    "labelDtos": [
 70      {
 71        "createdBy": "string",
 72        "lastModifiedBy": "string",
 73        "createdDate": "2019-08-24T14:15:22Z",
 74        "lastModifiedDate": "2019-08-24T14:15:22Z",
 75        "archived": true,
 76        "externalId": "string",
 77        "id": 0,
 78        "cultureId": 0,
 79        "value": "string"
 80      }
 81    ]
 82  },
 83  "appealAction": {
 84    "createdBy": "string",
 85    "lastModifiedBy": "string",
 86    "createdDate": "2019-08-24T14:15:22Z",
 87    "lastModifiedDate": "2019-08-24T14:15:22Z",
 88    "archived": true,
 89    "externalId": "string",
 90    "id": 0,
 91    "priority": 0,
 92    "internalId": 0,
 93    "pickListCode": "string",
 94    "pickListLabel": "string",
 95    "label": "string",
 96    "cultureId": 0,
 97    "labelDtos": [
 98      {
 99        "createdBy": "string",
100        "lastModifiedBy": "string",
101        "createdDate": "2019-08-24T14:15:22Z",
102        "lastModifiedDate": "2019-08-24T14:15:22Z",
103        "archived": true,
104        "externalId": "string",
105        "id": 0,
106        "cultureId": 0,
107        "value": "string"
108      }
109    ]
110  },
111  "appealNegotiation": {
112    "createdBy": "string",
113    "lastModifiedBy": "string",
114    "createdDate": "2019-08-24T14:15:22Z",
115    "lastModifiedDate": "2019-08-24T14:15:22Z",
116    "archived": true,
117    "externalId": "string",
118    "id": 0,
119    "priority": 0,
120    "internalId": 0,
121    "pickListCode": "string",
122    "pickListLabel": "string",
123    "label": "string",
124    "cultureId": 0,
125    "labelDtos": [
126      {
127        "createdBy": "string",
128        "lastModifiedBy": "string",
129        "createdDate": "2019-08-24T14:15:22Z",
130        "lastModifiedDate": "2019-08-24T14:15:22Z",
131        "archived": true,
132        "externalId": "string",
133        "id": 0,
134        "cultureId": 0,
135        "value": "string"
136      }
137    ]
138  }
139}

Update Appeal

HTTP Request

PUT /api/appeals/{id}

📋 Description: Updates the details of a specific appeal within the Nakisa Portfolio Management Suite, enabling users to manage portfolio-related assets and analytics for real estate properties effectively.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

body

body

AppealDto

true

Request body containing the updated appeal details, including portfolio identifiers, asset information, and relevant analytics for real estate property management.

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  "appealAssessmentId": 0,
 10  "appealReviewedId": 0,
 11  "appealed": true,
 12  "appealActionId": 0,
 13  "followUpDate": "2019-08-24",
 14  "targetedAssessment": 0,
 15  "revisedAssessment": 0,
 16  "appealNegotiationId": 0,
 17  "settlementDate": "2019-08-24",
 18  "note": "string",
 19  "savings": [
 20    {
 21      "year": 0,
 22      "savings": 0
 23    }
 24  ],
 25  "assessmentId": 0,
 26  "assessmentExternalId": "string",
 27  "appealAssessment": {
 28    "createdBy": "string",
 29    "lastModifiedBy": "string",
 30    "createdDate": "2019-08-24T14:15:22Z",
 31    "lastModifiedDate": "2019-08-24T14:15:22Z",
 32    "archived": true,
 33    "externalId": "string",
 34    "id": 0,
 35    "priority": 0,
 36    "internalId": 0,
 37    "pickListCode": "string",
 38    "pickListLabel": "string",
 39    "label": "string",
 40    "cultureId": 0,
 41    "labelDtos": [
 42      {
 43        "createdBy": "string",
 44        "lastModifiedBy": "string",
 45        "createdDate": "2019-08-24T14:15:22Z",
 46        "lastModifiedDate": "2019-08-24T14:15:22Z",
 47        "archived": true,
 48        "externalId": "string",
 49        "id": 0,
 50        "cultureId": 0,
 51        "value": "string"
 52      }
 53    ]
 54  },
 55  "appealReviewed": {
 56    "createdBy": "string",
 57    "lastModifiedBy": "string",
 58    "createdDate": "2019-08-24T14:15:22Z",
 59    "lastModifiedDate": "2019-08-24T14:15:22Z",
 60    "archived": true,
 61    "externalId": "string",
 62    "id": 0,
 63    "priority": 0,
 64    "internalId": 0,
 65    "pickListCode": "string",
 66    "pickListLabel": "string",
 67    "label": "string",
 68    "cultureId": 0,
 69    "labelDtos": [
 70      {
 71        "createdBy": "string",
 72        "lastModifiedBy": "string",
 73        "createdDate": "2019-08-24T14:15:22Z",
 74        "lastModifiedDate": "2019-08-24T14:15:22Z",
 75        "archived": true,
 76        "externalId": "string",
 77        "id": 0,
 78        "cultureId": 0,
 79        "value": "string"
 80      }
 81    ]
 82  },
 83  "appealAction": {
 84    "createdBy": "string",
 85    "lastModifiedBy": "string",
 86    "createdDate": "2019-08-24T14:15:22Z",
 87    "lastModifiedDate": "2019-08-24T14:15:22Z",
 88    "archived": true,
 89    "externalId": "string",
 90    "id": 0,
 91    "priority": 0,
 92    "internalId": 0,
 93    "pickListCode": "string",
 94    "pickListLabel": "string",
 95    "label": "string",
 96    "cultureId": 0,
 97    "labelDtos": [
 98      {
 99        "createdBy": "string",
100        "lastModifiedBy": "string",
101        "createdDate": "2019-08-24T14:15:22Z",
102        "lastModifiedDate": "2019-08-24T14:15:22Z",
103        "archived": true,
104        "externalId": "string",
105        "id": 0,
106        "cultureId": 0,
107        "value": "string"
108      }
109    ]
110  },
111  "appealNegotiation": {
112    "createdBy": "string",
113    "lastModifiedBy": "string",
114    "createdDate": "2019-08-24T14:15:22Z",
115    "lastModifiedDate": "2019-08-24T14:15:22Z",
116    "archived": true,
117    "externalId": "string",
118    "id": 0,
119    "priority": 0,
120    "internalId": 0,
121    "pickListCode": "string",
122    "pickListLabel": "string",
123    "label": "string",
124    "cultureId": 0,
125    "labelDtos": [
126      {
127        "createdBy": "string",
128        "lastModifiedBy": "string",
129        "createdDate": "2019-08-24T14:15:22Z",
130        "lastModifiedDate": "2019-08-24T14:15:22Z",
131        "archived": true,
132        "externalId": "string",
133        "id": 0,
134        "cultureId": 0,
135        "value": "string"
136      }
137    ]
138  }
139}

Responses

Status

Meaning

Description

Schema

200

OK

OK

AppealDto

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  "appealAssessmentId": 0,
 10  "appealReviewedId": 0,
 11  "appealed": true,
 12  "appealActionId": 0,
 13  "followUpDate": "2019-08-24",
 14  "targetedAssessment": 0,
 15  "revisedAssessment": 0,
 16  "appealNegotiationId": 0,
 17  "settlementDate": "2019-08-24",
 18  "note": "string",
 19  "savings": [
 20    {
 21      "year": 0,
 22      "savings": 0
 23    }
 24  ],
 25  "assessmentId": 0,
 26  "assessmentExternalId": "string",
 27  "appealAssessment": {
 28    "createdBy": "string",
 29    "lastModifiedBy": "string",
 30    "createdDate": "2019-08-24T14:15:22Z",
 31    "lastModifiedDate": "2019-08-24T14:15:22Z",
 32    "archived": true,
 33    "externalId": "string",
 34    "id": 0,
 35    "priority": 0,
 36    "internalId": 0,
 37    "pickListCode": "string",
 38    "pickListLabel": "string",
 39    "label": "string",
 40    "cultureId": 0,
 41    "labelDtos": [
 42      {
 43        "createdBy": "string",
 44        "lastModifiedBy": "string",
 45        "createdDate": "2019-08-24T14:15:22Z",
 46        "lastModifiedDate": "2019-08-24T14:15:22Z",
 47        "archived": true,
 48        "externalId": "string",
 49        "id": 0,
 50        "cultureId": 0,
 51        "value": "string"
 52      }
 53    ]
 54  },
 55  "appealReviewed": {
 56    "createdBy": "string",
 57    "lastModifiedBy": "string",
 58    "createdDate": "2019-08-24T14:15:22Z",
 59    "lastModifiedDate": "2019-08-24T14:15:22Z",
 60    "archived": true,
 61    "externalId": "string",
 62    "id": 0,
 63    "priority": 0,
 64    "internalId": 0,
 65    "pickListCode": "string",
 66    "pickListLabel": "string",
 67    "label": "string",
 68    "cultureId": 0,
 69    "labelDtos": [
 70      {
 71        "createdBy": "string",
 72        "lastModifiedBy": "string",
 73        "createdDate": "2019-08-24T14:15:22Z",
 74        "lastModifiedDate": "2019-08-24T14:15:22Z",
 75        "archived": true,
 76        "externalId": "string",
 77        "id": 0,
 78        "cultureId": 0,
 79        "value": "string"
 80      }
 81    ]
 82  },
 83  "appealAction": {
 84    "createdBy": "string",
 85    "lastModifiedBy": "string",
 86    "createdDate": "2019-08-24T14:15:22Z",
 87    "lastModifiedDate": "2019-08-24T14:15:22Z",
 88    "archived": true,
 89    "externalId": "string",
 90    "id": 0,
 91    "priority": 0,
 92    "internalId": 0,
 93    "pickListCode": "string",
 94    "pickListLabel": "string",
 95    "label": "string",
 96    "cultureId": 0,
 97    "labelDtos": [
 98      {
 99        "createdBy": "string",
100        "lastModifiedBy": "string",
101        "createdDate": "2019-08-24T14:15:22Z",
102        "lastModifiedDate": "2019-08-24T14:15:22Z",
103        "archived": true,
104        "externalId": "string",
105        "id": 0,
106        "cultureId": 0,
107        "value": "string"
108      }
109    ]
110  },
111  "appealNegotiation": {
112    "createdBy": "string",
113    "lastModifiedBy": "string",
114    "createdDate": "2019-08-24T14:15:22Z",
115    "lastModifiedDate": "2019-08-24T14:15:22Z",
116    "archived": true,
117    "externalId": "string",
118    "id": 0,
119    "priority": 0,
120    "internalId": 0,
121    "pickListCode": "string",
122    "pickListLabel": "string",
123    "label": "string",
124    "cultureId": 0,
125    "labelDtos": [
126      {
127        "createdBy": "string",
128        "lastModifiedBy": "string",
129        "createdDate": "2019-08-24T14:15:22Z",
130        "lastModifiedDate": "2019-08-24T14:15:22Z",
131        "archived": true,
132        "externalId": "string",
133        "id": 0,
134        "cultureId": 0,
135        "value": "string"
136      }
137    ]
138  }
139}

Delete Appeal

HTTP Request

DELETE /api/appeals/{id}

📋 Description: Deletes a specified appeal from the Nakisa Portfolio Management Suite, ensuring that portfolio and asset analytics remain current and relevant for real estate property management.

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

Get Documents

HTTP Request

GET /api/appeals/{id}/documents

📋 Description: Retrieves documents associated with a specific appeal in the Nakisa Portfolio Management Suite, enabling users to access relevant information for portfolio, asset, and real estate property analytics.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

pageable

query

Pageable

true

Indicates whether the response should be paginated, facilitating efficient retrieval of documents related to a specific appeal within the Nakisa Portfolio Management Suite.

search

query

string

false

Search term used to filter and retrieve specific documents related to the appeal identified by {id} 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 the appeal document, facilitating efficient tracking and management within the Nakisa Portfolio Management Suite.

signed-date

query

string

false

Specifies the date on which the document was signed, providing essential context for portfolio and asset management 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 associated with the appeal is shareable within the Nakisa Portfolio Management Suite, facilitating collaboration and transparency in portfolio and asset management.

document-type-id

query

string

false

Unique identifier for the type of document associated with a specific appeal within the Nakisa Portfolio Management Suite, facilitating efficient management of portfolio, asset, and real estate property analytics.

document-type-id-in

query

string

false

Specifies the unique identifier for the document type to filter the retrieved documents associated with the specified appeal in the Nakisa Portfolio Management Suite.

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}

Upload Document

HTTP Request

POST /api/appeals/{id}/documents

📋 Description: Uploads documents associated with a specific appeal in the Nakisa Portfolio Management Suite, facilitating enhanced portfolio and asset management for real estate properties.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

body

body

object

false

Request body containing the document details related to the specified appeal, including metadata and associated asset information for effective portfolio management.

» file

body

string(binary)

false

none

» document

body

DocumentDto

true

Data transfer object representing a document within the Nakisa Portfolio Management Suite, encapsulating essential information related to portfolio assets, analytics, and real estate properties.

»» createdBy

body

string

false

Username of who created this resource

»» lastModifiedBy

body

string

false

Username of who last modified this resource

»» createdDate

body

string(date-time)

false

Date of the created

»» lastModifiedDate

body

string(date-time)

false

Date of the last modified

»» archived

body

boolean

false

Boolean flag indicating archived status

»» externalId

body

string

false

Unique identifier for the external

»» id

body

integer(int64)

false

Unique identifier for the resource

»» name

body

string

false

Name of the resource

»» title

body

string

false

Title of the resource

»» type

body

string

false

Type of the resource

»» description

body

string

false

Description of the resource

»» link

body

string

false

Text value for link in DocumentDto

»» signedDate

body

string(date)

false

Date of the signed

»» documentTypeId

body

integer(int64)

false

Unique identifier for the document type

»» statusId

body

integer(int64)

false

Unique identifier for the status

»» shareable

body

boolean

false

Boolean flag indicating shareable status

»» size

body

integer(int64)

false

Number of items per page

»» documentType

body

PickListOptionDto

false

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

body

string

false

Username of who created this resource

»»» lastModifiedBy

body

string

false

Username of who last modified this resource

»»» createdDate

body

string(date-time)

false

Date of the created

»»» lastModifiedDate

body

string(date-time)

false

Date of the last modified

»»» archived

body

boolean

false

Boolean flag indicating archived status

»»» externalId

body

string

false

Unique identifier for the external

»»» id

body

integer(int64)

false

Unique identifier for the resource

»»» priority

body

integer(int64)

false

Priority of the resource

»»» internalId

body

integer(int64)

false

Unique identifier for the internal

»»» pickListCode

body

string

false

Code for the pick list

»»» pickListLabel

body

string

false

Label for the pick list

»»» label

body

string

false

Label for the resource

»»» cultureId

body

integer(int64)

false

Unique identifier for the culture

»»» labelDtos

body

[LabelDto]

false

List of labelDtos items

»»»» createdBy

body

string

false

Username of who created this resource

»»»» lastModifiedBy

body

string

false

Username of who last modified this resource

»»»» createdDate

body

string(date-time)

false

Date of the created

»»»» lastModifiedDate

body

string(date-time)

false

Date of the last modified

»»»» archived

body

boolean

false

Boolean flag indicating archived status

»»»» externalId

body

string

false

Unique identifier for the external

»»»» id

body

integer(int64)

false

Unique identifier for the resource

»»»» cultureId

body

integer(int64)

false

Unique identifier for the culture

»»»» value

body

string

true

Text value for value in LabelDto

»» status

body

PickListOptionDto

false

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.

Body Parameters

 1{
 2    "document": {
 3        "archived": true,
 4        "createdBy": "string",
 5        "createdDate": "2019-08-24 14:15:22+00:00",
 6        "description": "string",
 7        "documentType": {
 8            "archived": true,
 9            "createdBy": "string",
10            "createdDate": "2019-08-24 14:15:22+00:00",
11            "cultureId": 0,
12            "externalId": "string",
13            "id": 0,
14            "internalId": 0,
15            "label": "string",
16            "labelDtos": [
17                {
18                    "archived": true,
19                    "createdBy": "string",
20                    "createdDate": "2019-08-24 14:15:22+00:00",
21                    "cultureId": 0,
22                    "externalId": "string",
23                    "id": 0,
24                    "lastModifiedBy": "string",
25                    "lastModifiedDate": "2019-08-24 14:15:22+00:00",
26                    "value": "string"
27                }
28            ],
29            "lastModifiedBy": "string",
30            "lastModifiedDate": "2019-08-24 14:15:22+00:00",
31            "pickListCode": "string",
32            "pickListLabel": "string",
33            "priority": 0
34        },
35        "documentTypeId": 0,
36        "externalId": "string",
37        "id": 0,
38        "lastModifiedBy": "string",
39        "lastModifiedDate": "2019-08-24 14:15:22+00:00",
40        "link": "string",
41        "name": "string",
42        "shareable": true,
43        "signedDate": "2019-08-24",
44        "size": 0,
45        "status": {
46            "archived": true,
47            "createdBy": "string",
48            "createdDate": "2019-08-24 14:15:22+00:00",
49            "cultureId": 0,
50            "externalId": "string",
51            "id": 0,
52            "internalId": 0,
53            "label": "string",
54            "labelDtos": [
55                {
56                    "archived": true,
57                    "createdBy": "string",
58                    "createdDate": "2019-08-24 14:15:22+00:00",
59                    "cultureId": 0,
60                    "externalId": "string",
61                    "id": 0,
62                    "lastModifiedBy": "string",
63                    "lastModifiedDate": "2019-08-24 14:15:22+00:00",
64                    "value": "string"
65                }
66            ],
67            "lastModifiedBy": "string",
68            "lastModifiedDate": "2019-08-24 14:15:22+00:00",
69            "pickListCode": "string",
70            "pickListLabel": "string",
71            "priority": 0
72        },
73        "statusId": 0,
74        "title": "string",
75        "type": "string"
76    },
77    "file": "string"
78}

Responses

Status

Meaning

Description

Schema

201

Created

Created

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}

Download Document

HTTP Request

GET /api/appeals/{id}/documents/{documentId}/download

📋 Description: Downloads the specified document associated with a particular appeal, facilitating access to critical documentation for portfolio and asset management 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

OK

StreamingResponseBody

Example Responses

1{}

Delete Document

HTTP Request

DELETE /api/appeals/{id}/documents/{documentId}

📋 Description: Deletes a specific document associated with an appeal in the Nakisa Portfolio Management Suite, facilitating efficient management of portfolio-related documentation for real estate assets.

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

OK

None