Contract Partner

Get Contract Partner

HTTP Request

GET /api/contract-partners/{id}

📋 Description: Retrieves detailed information about a specific contract partner within the Nakisa Portfolio Management Suite, enabling users to analyze portfolio and asset relationships 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

ContractPartnerDto

Example Responses

  1{
  2  "id": 0,
  3  "displayId": "string",
  4  "partner": {
  5    "id": 0,
  6    "displayId": "string",
  7    "status": "CREATED",
  8    "name": "string",
  9    "erpSystemDisplayId": "string"
 10  },
 11  "partnerRole": {
 12    "id": 0,
 13    "displayId": "string",
 14    "status": "CREATED",
 15    "name": "string"
 16  },
 17  "fromDate": "2019-08-24",
 18  "toDate": "2019-08-24",
 19  "masterAgreementPartnerId": 0,
 20  "replacedPartner": {
 21    "id": 0,
 22    "displayId": "string",
 23    "partner": {
 24      "id": 0,
 25      "displayId": "string",
 26      "status": "CREATED",
 27      "name": "string",
 28      "erpSystemDisplayId": "string"
 29    },
 30    "partnerRole": {
 31      "id": 0,
 32      "displayId": "string",
 33      "status": "CREATED",
 34      "name": "string"
 35    },
 36    "fromDate": "2019-08-24",
 37    "toDate": "2019-08-24",
 38    "masterAgreementPartnerId": 0,
 39    "replacedPartner": {},
 40    "replacedByPartner": {},
 41    "parentContractPartnerId": 0,
 42    "contractRevisionId": 0,
 43    "contractId": 0,
 44    "contractDisplayId": "string",
 45    "allowsSystemGenerateNewId": true,
 46    "numberRangeIdentifierType": {
 47      "name": "string"
 48    },
 49    "numberRangeIdentifierValue": "string",
 50    "numberRangeType": {
 51      "name": "string"
 52    }
 53  },
 54  "replacedByPartner": {
 55    "id": 0,
 56    "displayId": "string",
 57    "partner": {
 58      "id": 0,
 59      "displayId": "string",
 60      "status": "CREATED",
 61      "name": "string",
 62      "erpSystemDisplayId": "string"
 63    },
 64    "partnerRole": {
 65      "id": 0,
 66      "displayId": "string",
 67      "status": "CREATED",
 68      "name": "string"
 69    },
 70    "fromDate": "2019-08-24",
 71    "toDate": "2019-08-24",
 72    "masterAgreementPartnerId": 0,
 73    "replacedPartner": {},
 74    "replacedByPartner": {},
 75    "parentContractPartnerId": 0,
 76    "contractRevisionId": 0,
 77    "contractId": 0,
 78    "contractDisplayId": "string",
 79    "allowsSystemGenerateNewId": true,
 80    "numberRangeIdentifierType": {
 81      "name": "string"
 82    },
 83    "numberRangeIdentifierValue": "string",
 84    "numberRangeType": {
 85      "name": "string"
 86    }
 87  },
 88  "parentContractPartnerId": 0,
 89  "contractRevisionId": 0,
 90  "contractId": 0,
 91  "contractDisplayId": "string",
 92  "allowsSystemGenerateNewId": true,
 93  "numberRangeIdentifierType": {
 94    "name": "string"
 95  },
 96  "numberRangeIdentifierValue": "string",
 97  "numberRangeType": {
 98    "name": "string"
 99  }
100}

Update Contract Partner

HTTP Request

PUT /api/contract-partners/{id}

📋 Description: Updates the details of a specified contract partner within the Nakisa Portfolio Management Suite, enabling accurate management of portfolio and asset information in the context of real estate property analytics.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

body

body

ContractPartnerDto

true

Request body containing updated contract partner information, including details relevant to portfolio management, asset allocation, and real estate property analytics.

Body Parameters

  1{
  2  "id": 0,
  3  "displayId": "string",
  4  "partner": {
  5    "id": 0,
  6    "displayId": "string",
  7    "status": "CREATED",
  8    "name": "string",
  9    "erpSystemDisplayId": "string"
 10  },
 11  "partnerRole": {
 12    "id": 0,
 13    "displayId": "string",
 14    "status": "CREATED",
 15    "name": "string"
 16  },
 17  "fromDate": "2019-08-24",
 18  "toDate": "2019-08-24",
 19  "masterAgreementPartnerId": 0,
 20  "replacedPartner": {
 21    "id": 0,
 22    "displayId": "string",
 23    "partner": {
 24      "id": 0,
 25      "displayId": "string",
 26      "status": "CREATED",
 27      "name": "string",
 28      "erpSystemDisplayId": "string"
 29    },
 30    "partnerRole": {
 31      "id": 0,
 32      "displayId": "string",
 33      "status": "CREATED",
 34      "name": "string"
 35    },
 36    "fromDate": "2019-08-24",
 37    "toDate": "2019-08-24",
 38    "masterAgreementPartnerId": 0,
 39    "replacedPartner": {},
 40    "replacedByPartner": {},
 41    "parentContractPartnerId": 0,
 42    "contractRevisionId": 0,
 43    "contractId": 0,
 44    "contractDisplayId": "string",
 45    "allowsSystemGenerateNewId": true,
 46    "numberRangeIdentifierType": {
 47      "name": "string"
 48    },
 49    "numberRangeIdentifierValue": "string",
 50    "numberRangeType": {
 51      "name": "string"
 52    }
 53  },
 54  "replacedByPartner": {
 55    "id": 0,
 56    "displayId": "string",
 57    "partner": {
 58      "id": 0,
 59      "displayId": "string",
 60      "status": "CREATED",
 61      "name": "string",
 62      "erpSystemDisplayId": "string"
 63    },
 64    "partnerRole": {
 65      "id": 0,
 66      "displayId": "string",
 67      "status": "CREATED",
 68      "name": "string"
 69    },
 70    "fromDate": "2019-08-24",
 71    "toDate": "2019-08-24",
 72    "masterAgreementPartnerId": 0,
 73    "replacedPartner": {},
 74    "replacedByPartner": {},
 75    "parentContractPartnerId": 0,
 76    "contractRevisionId": 0,
 77    "contractId": 0,
 78    "contractDisplayId": "string",
 79    "allowsSystemGenerateNewId": true,
 80    "numberRangeIdentifierType": {
 81      "name": "string"
 82    },
 83    "numberRangeIdentifierValue": "string",
 84    "numberRangeType": {
 85      "name": "string"
 86    }
 87  },
 88  "parentContractPartnerId": 0,
 89  "contractRevisionId": 0,
 90  "contractId": 0,
 91  "contractDisplayId": "string",
 92  "allowsSystemGenerateNewId": true,
 93  "numberRangeIdentifierType": {
 94    "name": "string"
 95  },
 96  "numberRangeIdentifierValue": "string",
 97  "numberRangeType": {
 98    "name": "string"
 99  }
100}

Responses

Status

Meaning

Description

Schema

200

OK

OK

ContractPartnerDto

Example Responses

  1{
  2  "id": 0,
  3  "displayId": "string",
  4  "partner": {
  5    "id": 0,
  6    "displayId": "string",
  7    "status": "CREATED",
  8    "name": "string",
  9    "erpSystemDisplayId": "string"
 10  },
 11  "partnerRole": {
 12    "id": 0,
 13    "displayId": "string",
 14    "status": "CREATED",
 15    "name": "string"
 16  },
 17  "fromDate": "2019-08-24",
 18  "toDate": "2019-08-24",
 19  "masterAgreementPartnerId": 0,
 20  "replacedPartner": {
 21    "id": 0,
 22    "displayId": "string",
 23    "partner": {
 24      "id": 0,
 25      "displayId": "string",
 26      "status": "CREATED",
 27      "name": "string",
 28      "erpSystemDisplayId": "string"
 29    },
 30    "partnerRole": {
 31      "id": 0,
 32      "displayId": "string",
 33      "status": "CREATED",
 34      "name": "string"
 35    },
 36    "fromDate": "2019-08-24",
 37    "toDate": "2019-08-24",
 38    "masterAgreementPartnerId": 0,
 39    "replacedPartner": {},
 40    "replacedByPartner": {},
 41    "parentContractPartnerId": 0,
 42    "contractRevisionId": 0,
 43    "contractId": 0,
 44    "contractDisplayId": "string",
 45    "allowsSystemGenerateNewId": true,
 46    "numberRangeIdentifierType": {
 47      "name": "string"
 48    },
 49    "numberRangeIdentifierValue": "string",
 50    "numberRangeType": {
 51      "name": "string"
 52    }
 53  },
 54  "replacedByPartner": {
 55    "id": 0,
 56    "displayId": "string",
 57    "partner": {
 58      "id": 0,
 59      "displayId": "string",
 60      "status": "CREATED",
 61      "name": "string",
 62      "erpSystemDisplayId": "string"
 63    },
 64    "partnerRole": {
 65      "id": 0,
 66      "displayId": "string",
 67      "status": "CREATED",
 68      "name": "string"
 69    },
 70    "fromDate": "2019-08-24",
 71    "toDate": "2019-08-24",
 72    "masterAgreementPartnerId": 0,
 73    "replacedPartner": {},
 74    "replacedByPartner": {},
 75    "parentContractPartnerId": 0,
 76    "contractRevisionId": 0,
 77    "contractId": 0,
 78    "contractDisplayId": "string",
 79    "allowsSystemGenerateNewId": true,
 80    "numberRangeIdentifierType": {
 81      "name": "string"
 82    },
 83    "numberRangeIdentifierValue": "string",
 84    "numberRangeType": {
 85      "name": "string"
 86    }
 87  },
 88  "parentContractPartnerId": 0,
 89  "contractRevisionId": 0,
 90  "contractId": 0,
 91  "contractDisplayId": "string",
 92  "allowsSystemGenerateNewId": true,
 93  "numberRangeIdentifierType": {
 94    "name": "string"
 95  },
 96  "numberRangeIdentifierValue": "string",
 97  "numberRangeType": {
 98    "name": "string"
 99  }
100}

Delete Contract Partner

HTTP Request

DELETE /api/contract-partners/{id}

📋 Description: Deletes a specified contract partner from the Nakisa Portfolio Management Suite, facilitating the management of portfolio and asset data within real estate property analytics.

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

Create Contract Partner

HTTP Request

POST /api/contract-partners

📋 Description: Creates a new contract partner within the Nakisa Portfolio Management Suite, enabling enhanced management and analytics of portfolio assets related to real estate properties.

Parameters

Name

In

Type

Required

Description

body

body

ContractPartnerDto

true

Request body containing the contract partner details, including identification, role, and associated portfolio information for effective asset and real estate property management.

Body Parameters

  1{
  2  "id": 0,
  3  "displayId": "string",
  4  "partner": {
  5    "id": 0,
  6    "displayId": "string",
  7    "status": "CREATED",
  8    "name": "string",
  9    "erpSystemDisplayId": "string"
 10  },
 11  "partnerRole": {
 12    "id": 0,
 13    "displayId": "string",
 14    "status": "CREATED",
 15    "name": "string"
 16  },
 17  "fromDate": "2019-08-24",
 18  "toDate": "2019-08-24",
 19  "masterAgreementPartnerId": 0,
 20  "replacedPartner": {
 21    "id": 0,
 22    "displayId": "string",
 23    "partner": {
 24      "id": 0,
 25      "displayId": "string",
 26      "status": "CREATED",
 27      "name": "string",
 28      "erpSystemDisplayId": "string"
 29    },
 30    "partnerRole": {
 31      "id": 0,
 32      "displayId": "string",
 33      "status": "CREATED",
 34      "name": "string"
 35    },
 36    "fromDate": "2019-08-24",
 37    "toDate": "2019-08-24",
 38    "masterAgreementPartnerId": 0,
 39    "replacedPartner": {},
 40    "replacedByPartner": {},
 41    "parentContractPartnerId": 0,
 42    "contractRevisionId": 0,
 43    "contractId": 0,
 44    "contractDisplayId": "string",
 45    "allowsSystemGenerateNewId": true,
 46    "numberRangeIdentifierType": {
 47      "name": "string"
 48    },
 49    "numberRangeIdentifierValue": "string",
 50    "numberRangeType": {
 51      "name": "string"
 52    }
 53  },
 54  "replacedByPartner": {
 55    "id": 0,
 56    "displayId": "string",
 57    "partner": {
 58      "id": 0,
 59      "displayId": "string",
 60      "status": "CREATED",
 61      "name": "string",
 62      "erpSystemDisplayId": "string"
 63    },
 64    "partnerRole": {
 65      "id": 0,
 66      "displayId": "string",
 67      "status": "CREATED",
 68      "name": "string"
 69    },
 70    "fromDate": "2019-08-24",
 71    "toDate": "2019-08-24",
 72    "masterAgreementPartnerId": 0,
 73    "replacedPartner": {},
 74    "replacedByPartner": {},
 75    "parentContractPartnerId": 0,
 76    "contractRevisionId": 0,
 77    "contractId": 0,
 78    "contractDisplayId": "string",
 79    "allowsSystemGenerateNewId": true,
 80    "numberRangeIdentifierType": {
 81      "name": "string"
 82    },
 83    "numberRangeIdentifierValue": "string",
 84    "numberRangeType": {
 85      "name": "string"
 86    }
 87  },
 88  "parentContractPartnerId": 0,
 89  "contractRevisionId": 0,
 90  "contractId": 0,
 91  "contractDisplayId": "string",
 92  "allowsSystemGenerateNewId": true,
 93  "numberRangeIdentifierType": {
 94    "name": "string"
 95  },
 96  "numberRangeIdentifierValue": "string",
 97  "numberRangeType": {
 98    "name": "string"
 99  }
100}

Responses

Status

Meaning

Description

Schema

201

Created

Created

ContractPartnerDto

Example Responses

  1{
  2  "id": 0,
  3  "displayId": "string",
  4  "partner": {
  5    "id": 0,
  6    "displayId": "string",
  7    "status": "CREATED",
  8    "name": "string",
  9    "erpSystemDisplayId": "string"
 10  },
 11  "partnerRole": {
 12    "id": 0,
 13    "displayId": "string",
 14    "status": "CREATED",
 15    "name": "string"
 16  },
 17  "fromDate": "2019-08-24",
 18  "toDate": "2019-08-24",
 19  "masterAgreementPartnerId": 0,
 20  "replacedPartner": {
 21    "id": 0,
 22    "displayId": "string",
 23    "partner": {
 24      "id": 0,
 25      "displayId": "string",
 26      "status": "CREATED",
 27      "name": "string",
 28      "erpSystemDisplayId": "string"
 29    },
 30    "partnerRole": {
 31      "id": 0,
 32      "displayId": "string",
 33      "status": "CREATED",
 34      "name": "string"
 35    },
 36    "fromDate": "2019-08-24",
 37    "toDate": "2019-08-24",
 38    "masterAgreementPartnerId": 0,
 39    "replacedPartner": {},
 40    "replacedByPartner": {},
 41    "parentContractPartnerId": 0,
 42    "contractRevisionId": 0,
 43    "contractId": 0,
 44    "contractDisplayId": "string",
 45    "allowsSystemGenerateNewId": true,
 46    "numberRangeIdentifierType": {
 47      "name": "string"
 48    },
 49    "numberRangeIdentifierValue": "string",
 50    "numberRangeType": {
 51      "name": "string"
 52    }
 53  },
 54  "replacedByPartner": {
 55    "id": 0,
 56    "displayId": "string",
 57    "partner": {
 58      "id": 0,
 59      "displayId": "string",
 60      "status": "CREATED",
 61      "name": "string",
 62      "erpSystemDisplayId": "string"
 63    },
 64    "partnerRole": {
 65      "id": 0,
 66      "displayId": "string",
 67      "status": "CREATED",
 68      "name": "string"
 69    },
 70    "fromDate": "2019-08-24",
 71    "toDate": "2019-08-24",
 72    "masterAgreementPartnerId": 0,
 73    "replacedPartner": {},
 74    "replacedByPartner": {},
 75    "parentContractPartnerId": 0,
 76    "contractRevisionId": 0,
 77    "contractId": 0,
 78    "contractDisplayId": "string",
 79    "allowsSystemGenerateNewId": true,
 80    "numberRangeIdentifierType": {
 81      "name": "string"
 82    },
 83    "numberRangeIdentifierValue": "string",
 84    "numberRangeType": {
 85      "name": "string"
 86    }
 87  },
 88  "parentContractPartnerId": 0,
 89  "contractRevisionId": 0,
 90  "contractId": 0,
 91  "contractDisplayId": "string",
 92  "allowsSystemGenerateNewId": true,
 93  "numberRangeIdentifierType": {
 94    "name": "string"
 95  },
 96  "numberRangeIdentifierValue": "string",
 97  "numberRangeType": {
 98    "name": "string"
 99  }
100}

Get Contract Partner Contacts

HTTP Request

GET /api/contract-partners/{id}/contacts

📋 Description: Fetches the contact details associated with a specified contract partner, facilitating enhanced communication and relationship management within the Nakisa Portfolio Management Suite.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

Inline

Example Responses

 1[
 2  {
 3    "id": 0,
 4    "displayId": "string",
 5    "name": "string",
 6    "position": "string",
 7    "email": "string",
 8    "phone": "string",
 9    "address": "string",
10    "description": "string",
11    "group": "string",
12    "buildingName": "string",
13    "fax": "string",
14    "allowsSystemGenerateNewId": true,
15    "numberRangeIdentifierType": {
16      "name": "string"
17    },
18    "numberRangeIdentifierValue": "string",
19    "numberRangeType": {
20      "name": "string"
21    }
22  }
23]

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[ContactDto]

false

none

[Data transfer object representing a contact within the Nakisa Portfolio Management Suite, encompassing essential details related to portfolio, asset, analytics, and real estate property management.]

» id

integer(int64)

false

none

Unique identifier for the resource

» displayId

string

false

none

Unique identifier for the display

» name

string

true

none

Name of the resource

» position

string

false

none

Text value for position in ContactDto

» email

string

true

none

Text value for email in ContactDto

» phone

string

false

none

Text value for phone in ContactDto

» address

string

false

none

Text value for address in ContactDto

» description

string

false

none

Description of the resource

» group

string

false

none

none

» buildingName

string

false

none

none

» fax

string

false

none

none

» allowsSystemGenerateNewId

boolean

false

none

Unique identifier for the allows system generate new

» numberRangeIdentifierType

INumberRangeIdentifierType

false

none

Data transfer object representing a numerical range identifier used for categorizing and analyzing assets within the Nakisa Portfolio Management Suite, specifically in the context of portfolio management, asset tracking, and real estate property analytics.

»» name

string

false

none

Name of the resource

» numberRangeIdentifierValue

string

false

none

Text value for numberRangeIdentifierValue in ContactDto

» numberRangeType

INumberRangeType

false

none

Data transfer object representing a numerical range utilized in the Nakisa Portfolio Management Suite, specifically designed for portfolio and asset analytics within the real estate property domain. This schema facilitates precise data representation and analysis of asset values and performance metrics.

»» name

string

false

none

Name of the resource

Post Contract Partner Contact

HTTP Request

POST /api/contract-partners/{id}/contacts

📋 Description: Adds a new contact for the specified contract partner within the Nakisa Portfolio Management Suite, enhancing portfolio management and analytics capabilities related to real estate properties.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

body

body

ContactDto

true

Request body containing contact information and details for the specified contract partner, essential for managing portfolio and asset relationships within the Nakisa Portfolio Management Suite.

Body Parameters

 1{
 2  "id": 0,
 3  "displayId": "string",
 4  "name": "string",
 5  "position": "string",
 6  "email": "string",
 7  "phone": "string",
 8  "address": "string",
 9  "description": "string",
10  "group": "string",
11  "buildingName": "string",
12  "fax": "string",
13  "allowsSystemGenerateNewId": true,
14  "numberRangeIdentifierType": {
15    "name": "string"
16  },
17  "numberRangeIdentifierValue": "string",
18  "numberRangeType": {
19    "name": "string"
20  }
21}

Responses

Status

Meaning

Description

Schema

200

OK

OK

ContactDto

Example Responses

 1{
 2  "id": 0,
 3  "displayId": "string",
 4  "name": "string",
 5  "position": "string",
 6  "email": "string",
 7  "phone": "string",
 8  "address": "string",
 9  "description": "string",
10  "group": "string",
11  "buildingName": "string",
12  "fax": "string",
13  "allowsSystemGenerateNewId": true,
14  "numberRangeIdentifierType": {
15    "name": "string"
16  },
17  "numberRangeIdentifierValue": "string",
18  "numberRangeType": {
19    "name": "string"
20  }
21}

Search Contract Partners

HTTP Request

POST /api/contract-partners/search

📋 Description: Submits a search request for contract partners within the Nakisa Portfolio Management Suite, enabling users to efficiently locate and analyze relevant portfolio and asset information related to real estate properties.

Parameters

Name

In

Type

Required

Description

body

body

ContractPartnerDtoFilter

true

Request body containing search criteria for contract partners, including portfolio details, asset classifications, and relevant analytics for real estate properties.

Body Parameters

 1{
 2  "idIn": [
 3    0
 4  ],
 5  "idEqual": 0,
 6  "idLike": "string",
 7  "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
 8  "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
 9  "createdByLike": "string",
10  "createdByEqual": "string",
11  "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
12  "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
13  "modifiedByLike": "string",
14  "modifiedByEqual": "string",
15  "displayIdIn": [
16    "string"
17  ],
18  "displayIdLike": "string",
19  "partnerIdIn": [
20    0
21  ],
22  "partnerDisplayIdIn": [
23    "string"
24  ],
25  "partnerRoleIdIn": [
26    0
27  ],
28  "partnerRoleDisplayIdIn": [
29    "string"
30  ],
31  "replacedPartnerIdIn": [
32    0
33  ],
34  "replacedPartnerIdEqual": 0,
35  "replacedPartnerIdLike": "string",
36  "replacedByPartnerIdIn": [
37    0
38  ],
39  "replacedByPartnerIdEqual": 0,
40  "replacedByPartnerIdLike": "string",
41  "contractRevisionIdIn": [
42    0
43  ],
44  "contractIdIn": [
45    0
46  ],
47  "contractDisplayIdIn": [
48    "string"
49  ]
50}

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageContractPartnerDto

Example Responses

 1{
 2  "totalElements": 0,
 3  "totalPages": 0,
 4  "pageable": {
 5    "paged": true,
 6    "unpaged": true,
 7    "pageNumber": 0,
 8    "pageSize": 0,
 9    "offset": 0,
10    "sort": {
11      "unsorted": true,
12      "sorted": true,
13      "empty": true
14    }
15  },
16  "numberOfElements": 0,
17  "size": 0,
18  "content": [
19    {
20      "id": 0,
21      "displayId": "string",
22      "partner": {
23        "id": 0,
24        "displayId": "string",
25        "status": "CREATED",
26        "name": "string",
27        "erpSystemDisplayId": "string"
28      },
29      "partnerRole": {
30        "id": 0,
31        "displayId": "string",
32        "status": "CREATED",
33        "name": "string"
34      },
35      "fromDate": "2019-08-24",
36      "toDate": "2019-08-24",
37      "masterAgreementPartnerId": 0,
38      "replacedPartner": {},
39      "replacedByPartner": {},
40      "parentContractPartnerId": 0,
41      "contractRevisionId": 0,
42      "contractId": 0,
43      "contractDisplayId": "string",
44      "allowsSystemGenerateNewId": true,
45      "numberRangeIdentifierType": {
46        "name": "string"
47      },
48      "numberRangeIdentifierValue": "string",
49      "numberRangeType": {
50        "name": "string"
51      }
52    }
53  ],
54  "number": 0,
55  "sort": {
56    "unsorted": true,
57    "sorted": true,
58    "empty": true
59  },
60  "first": true,
61  "last": true,
62  "empty": true
63}

Create Contract Partners

HTTP Request

POST /api/contract-partners/bulk

📋 Description: Submits a bulk upload of contract partner data to the Nakisa Portfolio Management Suite, enabling efficient management and analysis of real estate property assets within the portfolio.

Parameters

Name

In

Type

Required

Description

body

body

ContractPartnerDto

true

Request body containing a collection of contract partner data, including relevant details for portfolio management, asset tracking, and real estate analytics.

Body Parameters

 1[
 2  {
 3    "id": 0,
 4    "displayId": "string",
 5    "partner": {
 6      "id": 0,
 7      "displayId": "string",
 8      "status": "CREATED",
 9      "name": "string",
10      "erpSystemDisplayId": "string"
11    },
12    "partnerRole": {
13      "id": 0,
14      "displayId": "string",
15      "status": "CREATED",
16      "name": "string"
17    },
18    "fromDate": "2019-08-24",
19    "toDate": "2019-08-24",
20    "masterAgreementPartnerId": 0,
21    "replacedPartner": {},
22    "replacedByPartner": {},
23    "parentContractPartnerId": 0,
24    "contractRevisionId": 0,
25    "contractId": 0,
26    "contractDisplayId": "string",
27    "allowsSystemGenerateNewId": true,
28    "numberRangeIdentifierType": {
29      "name": "string"
30    },
31    "numberRangeIdentifierValue": "string",
32    "numberRangeType": {
33      "name": "string"
34    }
35  }
36]

Responses

Status

Meaning

Description

Schema

201

Created

Created

Inline

Example Responses

 1[
 2  {
 3    "id": 0,
 4    "displayId": "string",
 5    "partner": {
 6      "id": 0,
 7      "displayId": "string",
 8      "status": "CREATED",
 9      "name": "string",
10      "erpSystemDisplayId": "string"
11    },
12    "partnerRole": {
13      "id": 0,
14      "displayId": "string",
15      "status": "CREATED",
16      "name": "string"
17    },
18    "fromDate": "2019-08-24",
19    "toDate": "2019-08-24",
20    "masterAgreementPartnerId": 0,
21    "replacedPartner": {},
22    "replacedByPartner": {},
23    "parentContractPartnerId": 0,
24    "contractRevisionId": 0,
25    "contractId": 0,
26    "contractDisplayId": "string",
27    "allowsSystemGenerateNewId": true,
28    "numberRangeIdentifierType": {
29      "name": "string"
30    },
31    "numberRangeIdentifierValue": "string",
32    "numberRangeType": {
33      "name": "string"
34    }
35  }
36]

Response Schema

Status Code 201

Name

Type

Required

Restrictions

Description

anonymous

[ContractPartnerDto]

false

none

[Data transfer object representing a contractual partner associated with real estate assets within the Nakisa Portfolio Management Suite, facilitating portfolio analytics and management.]

» id

integer(int64)

false

none

Unique identifier for the resource

» displayId

string

false

none

Unique identifier for the display

» partner

PartnerLite

false

none

Data transfer object representing a streamlined partner profile within the Nakisa Portfolio Management Suite, encompassing essential details for portfolio, asset, and analytics management in the real estate property sector.

»» id

integer(int64)

false

none

Unique identifier for the resource

»» displayId

string

false

none

Unique identifier for the display

»» status

string

false

none

Status of the resource

»» name

string

false

none

Name of the resource

»» erpSystemDisplayId

string

false

none

Unique identifier for the erp system display

» partnerRole

PartnerRoleLite

false

none

Data transfer object representing a simplified view of a partner’s role within the Nakisa Portfolio Management Suite, facilitating insights into portfolio, asset, and real estate property analytics.

»» id

integer(int64)

false

none

Unique identifier for the resource

»» displayId

string

false

none

Unique identifier for the display

»» status

string

false

none

Status of the resource

»» name

string

false

none

Name of the resource

» fromDate

string(date)

false

none

Date of the from

» toDate

string(date)

false

none

Date of the to

» masterAgreementPartnerId

integer(int64)

false

none

Unique identifier for the master agreement partner

» replacedPartner

ContractPartnerDto

false

none

Data transfer object representing a contractual partner associated with real estate assets within the Nakisa Portfolio Management Suite, facilitating portfolio analytics and management.

» replacedByPartner

ContractPartnerDto

false

none

Data transfer object representing a contractual partner associated with real estate assets within the Nakisa Portfolio Management Suite, facilitating portfolio analytics and management.

» parentContractPartnerId

integer(int64)

false

none

Unique identifier for the parent contract partner

» contractRevisionId

integer(int64)

true

none

Unique identifier for the contract revision

» contractId

integer(int64)

false

none

Unique identifier for the contract

» contractDisplayId

string

false

none

Unique identifier for the contract display

» allowsSystemGenerateNewId

boolean

false

none

Unique identifier for the allows system generate new

» numberRangeIdentifierType

INumberRangeIdentifierType

false

none

Data transfer object representing a numerical range identifier used for categorizing and analyzing assets within the Nakisa Portfolio Management Suite, specifically in the context of portfolio management, asset tracking, and real estate property analytics.

»» name

string

false

none

Name of the resource

» numberRangeIdentifierValue

string

false

none

Text value for numberRangeIdentifierValue in ContractPartnerDto

» numberRangeType

INumberRangeType

false

none

Data transfer object representing a numerical range utilized in the Nakisa Portfolio Management Suite, specifically designed for portfolio and asset analytics within the real estate property domain. This schema facilitates precise data representation and analysis of asset values and performance metrics.

»» name

string

false

none

Name of the resource

Enumerated Values

Attribute

Value

status

ACTIVE, CREATED, DECOMMISSIONED, DISABLED

Bulk Delete Contract Partners

HTTP Request

DELETE /api/contract-partners/bulk

📋 Description: Deletes multiple contract partners from the Nakisa Portfolio Management Suite, streamlining portfolio management by ensuring that only relevant asset and real estate property partnerships are maintained.

Parameters

Name

In

Type

Required

Description

body

body

array[integer]

true

Request body containing an array of contract partner identifiers to facilitate the bulk deletion of associated records within the Nakisa Portfolio Management Suite.

Body Parameters

1[
2  0
3]

Responses

Status

Meaning

Description

Schema

204

No Content

No Content

None

Get Contract Partners By Contract Revision Id

HTTP Request

GET /api/contract-partners/contract/{contractRevisionId}

📋 Description: Retrieves detailed information about a specific contract revision identified by the contractRevisionId, facilitating insights into portfolio and asset management within the Nakisa Portfolio Management Suite.

Parameters

Name

In

Type

Required

Description

contractRevisionId

path

integer(int64)

true

Unique identifier for the contract revision

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageContractPartnerDto

Example Responses

 1{
 2  "totalElements": 0,
 3  "totalPages": 0,
 4  "pageable": {
 5    "paged": true,
 6    "unpaged": true,
 7    "pageNumber": 0,
 8    "pageSize": 0,
 9    "offset": 0,
10    "sort": {
11      "unsorted": true,
12      "sorted": true,
13      "empty": true
14    }
15  },
16  "numberOfElements": 0,
17  "size": 0,
18  "content": [
19    {
20      "id": 0,
21      "displayId": "string",
22      "partner": {
23        "id": 0,
24        "displayId": "string",
25        "status": "CREATED",
26        "name": "string",
27        "erpSystemDisplayId": "string"
28      },
29      "partnerRole": {
30        "id": 0,
31        "displayId": "string",
32        "status": "CREATED",
33        "name": "string"
34      },
35      "fromDate": "2019-08-24",
36      "toDate": "2019-08-24",
37      "masterAgreementPartnerId": 0,
38      "replacedPartner": {},
39      "replacedByPartner": {},
40      "parentContractPartnerId": 0,
41      "contractRevisionId": 0,
42      "contractId": 0,
43      "contractDisplayId": "string",
44      "allowsSystemGenerateNewId": true,
45      "numberRangeIdentifierType": {
46        "name": "string"
47      },
48      "numberRangeIdentifierValue": "string",
49      "numberRangeType": {
50        "name": "string"
51      }
52    }
53  ],
54  "number": 0,
55  "sort": {
56    "unsorted": true,
57    "sorted": true,
58    "empty": true
59  },
60  "first": true,
61  "last": true,
62  "empty": true
63}

Delete Contract Partner Contact

HTTP Request

DELETE /api/contract-partners/{id}/contacts/{contactId}

📋 Description: Deletes a specified contact associated with a contract partner in the Nakisa Portfolio Management Suite, streamlining the management of portfolio-related contacts for enhanced asset and real estate property analytics.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

contactId

path

integer(int64)

true

Unique identifier for the contact

Responses

Status

Meaning

Description

Schema

200

OK

OK

None