Vacancy¶
Vacancy - Get Vacancy¶
HTTP Request
GET /api/vacancies/{id}
📋 Description: Retrieves detailed information about a specific vacancy within the Nakisa Portfolio Management Suite, enabling users to analyze asset allocation and portfolio 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 |
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 "unit": "string",
10 "area": 0,
11 "unitMeasureId": 0,
12 "vacantFrom": "2019-08-24",
13 "vacantTo": "2019-08-24",
14 "marketValue": 0,
15 "eligible": true,
16 "applicationDate": "2019-08-24",
17 "followUpDate": "2019-08-24",
18 "vacancyStatusId": 0,
19 "credit": 0,
20 "creditReceived": 0,
21 "note": "string",
22 "assessmentId": 0,
23 "assessmentExternalId": "string",
24 "unitMeasure": {
25 "createdBy": "string",
26 "lastModifiedBy": "string",
27 "createdDate": "2019-08-24T14:15:22Z",
28 "lastModifiedDate": "2019-08-24T14:15:22Z",
29 "archived": true,
30 "externalId": "string",
31 "id": 0,
32 "priority": 0,
33 "internalId": 0,
34 "pickListCode": "string",
35 "pickListLabel": "string",
36 "label": "string",
37 "cultureId": 0,
38 "labelDtos": [
39 {
40 "createdBy": "string",
41 "lastModifiedBy": "string",
42 "createdDate": "2019-08-24T14:15:22Z",
43 "lastModifiedDate": "2019-08-24T14:15:22Z",
44 "archived": true,
45 "externalId": "string",
46 "id": 0,
47 "cultureId": 0,
48 "value": "string"
49 }
50 ]
51 },
52 "vacancyStatus": {
53 "createdBy": "string",
54 "lastModifiedBy": "string",
55 "createdDate": "2019-08-24T14:15:22Z",
56 "lastModifiedDate": "2019-08-24T14:15:22Z",
57 "archived": true,
58 "externalId": "string",
59 "id": 0,
60 "priority": 0,
61 "internalId": 0,
62 "pickListCode": "string",
63 "pickListLabel": "string",
64 "label": "string",
65 "cultureId": 0,
66 "labelDtos": [
67 {
68 "createdBy": "string",
69 "lastModifiedBy": "string",
70 "createdDate": "2019-08-24T14:15:22Z",
71 "lastModifiedDate": "2019-08-24T14:15:22Z",
72 "archived": true,
73 "externalId": "string",
74 "id": 0,
75 "cultureId": 0,
76 "value": "string"
77 }
78 ]
79 }
80}
Vacancy - Update Vacancy¶
HTTP Request
PUT /api/vacancies/{id}
📋 Description: Updates the details of a specific vacancy within the Nakisa Portfolio Management Suite, enabling users to manage portfolio assets effectively and enhance real estate property analytics.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing updated vacancy details, including position specifications and asset allocation, to enhance portfolio management within the Nakisa Portfolio Management Suite. |
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 "unit": "string",
10 "area": 0,
11 "unitMeasureId": 0,
12 "vacantFrom": "2019-08-24",
13 "vacantTo": "2019-08-24",
14 "marketValue": 0,
15 "eligible": true,
16 "applicationDate": "2019-08-24",
17 "followUpDate": "2019-08-24",
18 "vacancyStatusId": 0,
19 "credit": 0,
20 "creditReceived": 0,
21 "note": "string",
22 "assessmentId": 0,
23 "assessmentExternalId": "string",
24 "unitMeasure": {
25 "createdBy": "string",
26 "lastModifiedBy": "string",
27 "createdDate": "2019-08-24T14:15:22Z",
28 "lastModifiedDate": "2019-08-24T14:15:22Z",
29 "archived": true,
30 "externalId": "string",
31 "id": 0,
32 "priority": 0,
33 "internalId": 0,
34 "pickListCode": "string",
35 "pickListLabel": "string",
36 "label": "string",
37 "cultureId": 0,
38 "labelDtos": [
39 {
40 "createdBy": "string",
41 "lastModifiedBy": "string",
42 "createdDate": "2019-08-24T14:15:22Z",
43 "lastModifiedDate": "2019-08-24T14:15:22Z",
44 "archived": true,
45 "externalId": "string",
46 "id": 0,
47 "cultureId": 0,
48 "value": "string"
49 }
50 ]
51 },
52 "vacancyStatus": {
53 "createdBy": "string",
54 "lastModifiedBy": "string",
55 "createdDate": "2019-08-24T14:15:22Z",
56 "lastModifiedDate": "2019-08-24T14:15:22Z",
57 "archived": true,
58 "externalId": "string",
59 "id": 0,
60 "priority": 0,
61 "internalId": 0,
62 "pickListCode": "string",
63 "pickListLabel": "string",
64 "label": "string",
65 "cultureId": 0,
66 "labelDtos": [
67 {
68 "createdBy": "string",
69 "lastModifiedBy": "string",
70 "createdDate": "2019-08-24T14:15:22Z",
71 "lastModifiedDate": "2019-08-24T14:15:22Z",
72 "archived": true,
73 "externalId": "string",
74 "id": 0,
75 "cultureId": 0,
76 "value": "string"
77 }
78 ]
79 }
80}
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 "unit": "string",
10 "area": 0,
11 "unitMeasureId": 0,
12 "vacantFrom": "2019-08-24",
13 "vacantTo": "2019-08-24",
14 "marketValue": 0,
15 "eligible": true,
16 "applicationDate": "2019-08-24",
17 "followUpDate": "2019-08-24",
18 "vacancyStatusId": 0,
19 "credit": 0,
20 "creditReceived": 0,
21 "note": "string",
22 "assessmentId": 0,
23 "assessmentExternalId": "string",
24 "unitMeasure": {
25 "createdBy": "string",
26 "lastModifiedBy": "string",
27 "createdDate": "2019-08-24T14:15:22Z",
28 "lastModifiedDate": "2019-08-24T14:15:22Z",
29 "archived": true,
30 "externalId": "string",
31 "id": 0,
32 "priority": 0,
33 "internalId": 0,
34 "pickListCode": "string",
35 "pickListLabel": "string",
36 "label": "string",
37 "cultureId": 0,
38 "labelDtos": [
39 {
40 "createdBy": "string",
41 "lastModifiedBy": "string",
42 "createdDate": "2019-08-24T14:15:22Z",
43 "lastModifiedDate": "2019-08-24T14:15:22Z",
44 "archived": true,
45 "externalId": "string",
46 "id": 0,
47 "cultureId": 0,
48 "value": "string"
49 }
50 ]
51 },
52 "vacancyStatus": {
53 "createdBy": "string",
54 "lastModifiedBy": "string",
55 "createdDate": "2019-08-24T14:15:22Z",
56 "lastModifiedDate": "2019-08-24T14:15:22Z",
57 "archived": true,
58 "externalId": "string",
59 "id": 0,
60 "priority": 0,
61 "internalId": 0,
62 "pickListCode": "string",
63 "pickListLabel": "string",
64 "label": "string",
65 "cultureId": 0,
66 "labelDtos": [
67 {
68 "createdBy": "string",
69 "lastModifiedBy": "string",
70 "createdDate": "2019-08-24T14:15:22Z",
71 "lastModifiedDate": "2019-08-24T14:15:22Z",
72 "archived": true,
73 "externalId": "string",
74 "id": 0,
75 "cultureId": 0,
76 "value": "string"
77 }
78 ]
79 }
80}
Vacancy - Delete Vacancy¶
HTTP Request
DELETE /api/vacancies/{id}
📋 Description: Deletes a specified vacancy from the Nakisa Portfolio Management Suite, ensuring accurate portfolio and asset management by removing outdated or unnecessary listings.
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 |
Vacancy - Get Documents¶
HTTP Request
GET /api/vacancies/{id}/documents
📋 Description: Fetches documents associated with a specific vacancy within the Nakisa Portfolio Management Suite, enabling users to access relevant information for portfolio and asset analysis in real estate property management.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
pageable |
query |
true |
Indicates whether the response should be paginated, allowing for efficient retrieval of documents associated with a specific vacancy in the Nakisa Portfolio Management Suite. |
|
search |
query |
string |
false |
Search term used to filter and retrieve specific documents related to the vacancy identified by the provided 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 documents associated with a specific vacancy in the Nakisa Portfolio Management Suite, facilitating effective portfolio and asset management. |
signed-date |
query |
string |
false |
Specifies the date on which the document associated with the vacancy 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 associated documents for the specified vacancy can be shared, facilitating collaboration and transparency within the portfolio management process. |
document-type-id |
query |
string |
false |
Unique identifier for the type of document associated with a specific vacancy within the Nakisa Portfolio Management Suite, facilitating efficient management and analysis of portfolio assets in real estate. |
document-type-id-in |
query |
string |
false |
Unique identifier for the type of document associated with a specific vacancy, facilitating the retrieval of relevant portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
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}
Vacancy - Upload Document¶
HTTP Request
POST /api/vacancies/{id}/documents
📋 Description: Uploads documents associated with a specific vacancy in the Nakisa Portfolio Management Suite, enhancing asset management and analytics 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 data associated with a specific vacancy, including relevant metadata for portfolio and asset management within the Nakisa Portfolio Management Suite. |
» file |
body |
string(binary) |
false |
none |
» document |
body |
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 |
URL link to access detailed information or resources related to the portfolio, asset, or real estate property within the Nakisa Portfolio Management Suite. |
»» 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 |
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 |
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 |
Represents the descriptive value associated with a portfolio asset, facilitating analytics and insights within the Nakisa Portfolio Management Suite. |
»» status |
body |
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 |
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}
Vacancy - Download Document¶
HTTP Request
GET /api/vacancies/{id}/documents/{documentId}/download
📋 Description: Downloads the specified document associated with a vacancy, enabling users to access critical information related to 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 |
Example Responses
1{}
Vacancy - Delete Document¶
HTTP Request
DELETE /api/vacancies/{id}/documents/{documentId}
📋 Description: Deletes a specified document associated with a vacancy in the Nakisa Portfolio Management Suite, facilitating effective management of portfolio-related assets and analytics in real estate properties.
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 |
None |