Consumer Price Index¶
Consumer Price Index - Search Consumer Price Index Categories¶
HTTP Request
POST /api/consumer-price-index-categories/search
📋 Description: Submits a search request for consumer price index categories, enabling users to analyze portfolio and asset performance within the Nakisa Portfolio Management Suite, particularly in the context of real estate property analytics.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing search criteria for consumer price index categories, including relevant filters and parameters to support portfolio and asset analytics within the real estate property domain. |
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 "statusEqual": "CREATED",
16 "statusIn": [
17 "CREATED"
18 ],
19 "displayIdIn": [
20 "string"
21 ],
22 "displayIdLike": "string",
23 "uiSelector": "string",
24 "nameLike": "string",
25 "countryLike": "string",
26 "provinceLike": "string",
27 "cityLike": "string",
28 "consumerPriceIndexSourceTypeIn": [
29 "WEB"
30 ],
31 "sourceLike": "string",
32 "formulaLike": "string",
33 "indexedCurrencyEqual": true,
34 "exchangeRateTypeLike": "string",
35 "erpSystemIdEqual": 0,
36 "erpSystemDisplayIdLike": "string",
37 "fromCurrencyIdEqual": 0,
38 "fromCurrencyDisplayIdLike": "string",
39 "toCurrencyIdEqual": 0,
40 "toCurrencyDisplayIdLike": "string",
41 "consumerPriceIndexValueIdEqual": "string",
42 "companyIdEqual": 0,
43 "companyIdIn": [
44 0
45 ]
46}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "totalElements": 0,
3 "totalPages": 0,
4 "pageable": {
5 "pageNumber": 0,
6 "pageSize": 0,
7 "unpaged": true,
8 "paged": true,
9 "offset": 0,
10 "sort": {
11 "sorted": true,
12 "unsorted": true,
13 "empty": true
14 }
15 },
16 "numberOfElements": 0,
17 "size": 0,
18 "content": [
19 {
20 "id": 0,
21 "status": "CREATED",
22 "displayId": "string",
23 "name": "string",
24 "country": "string",
25 "province": "string",
26 "city": "string",
27 "consumerPriceIndexSourceType": "WEB",
28 "source": "string",
29 "formula": "string",
30 "indexedCurrency": true,
31 "exchangeRateType": "string",
32 "erpSystemId": 0,
33 "erpSystemDisplayId": "string",
34 "fromCurrencyId": 0,
35 "fromCurrencyDisplayId": "string",
36 "toCurrencyId": 0,
37 "toCurrencyDisplayId": "string",
38 "consumerPriceIndexValueId": "string",
39 "companyId": 0
40 }
41 ],
42 "number": 0,
43 "sort": {
44 "sorted": true,
45 "unsorted": true,
46 "empty": true
47 },
48 "first": true,
49 "last": true,
50 "empty": true
51}
Consumer Price Index - Get Consumer Price Index Value By Category ID And Date¶
HTTP Request
GET /api/consumer-price-index-values/consumer-price-index-category/{categoryId}/{referenceDate}
📋 Description: Retrieves consumer price index values for a specified category and reference date, enabling portfolio and asset analytics within the Nakisa Portfolio Management Suite for informed real estate property decision-making.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
categoryId |
path |
integer(int64) |
true |
Unique identifier for the category |
referenceDate |
path |
string |
true |
Date of the reference |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "id": 0,
3 "status": "CREATED",
4 "displayId": "string",
5 "value": 0,
6 "effectiveDate": "2019-08-24",
7 "consumerPriceIndexCategoryId": 0,
8 "consumerPriceIndexCategoryDisplayId": "string",
9 "erpSystemId": 0,
10 "erpSystemDisplayId": "string"
11}
Consumer Price Index - Get Consumer Price Index Categories¶
HTTP Request
GET /api/consumer-price-index-categories
📋 Description: Retrieves a list of consumer price index categories relevant to portfolio and asset analytics within the Nakisa Portfolio Management Suite, facilitating informed decision-making in real estate property management.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "totalElements": 0,
3 "totalPages": 0,
4 "pageable": {
5 "pageNumber": 0,
6 "pageSize": 0,
7 "unpaged": true,
8 "paged": true,
9 "offset": 0,
10 "sort": {
11 "sorted": true,
12 "unsorted": true,
13 "empty": true
14 }
15 },
16 "numberOfElements": 0,
17 "size": 0,
18 "content": [
19 {
20 "id": 0,
21 "status": "CREATED",
22 "displayId": "string",
23 "name": "string",
24 "country": "string",
25 "province": "string",
26 "city": "string",
27 "consumerPriceIndexSourceType": "WEB",
28 "source": "string",
29 "formula": "string",
30 "indexedCurrency": true,
31 "exchangeRateType": "string",
32 "erpSystemId": 0,
33 "erpSystemDisplayId": "string",
34 "fromCurrencyId": 0,
35 "fromCurrencyDisplayId": "string",
36 "toCurrencyId": 0,
37 "toCurrencyDisplayId": "string",
38 "consumerPriceIndexValueId": "string",
39 "companyId": 0
40 }
41 ],
42 "number": 0,
43 "sort": {
44 "sorted": true,
45 "unsorted": true,
46 "empty": true
47 },
48 "first": true,
49 "last": true,
50 "empty": true
51}
Consumer Price Index - Get Consumer Price Index Category¶
HTTP Request
GET /api/consumer-price-index-categories/{id}
📋 Description: Retrieves detailed information about a specific consumer price index category by its unique identifier, facilitating informed decision-making in 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 |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "id": 0,
3 "status": "CREATED",
4 "displayId": "string",
5 "name": "string",
6 "country": "string",
7 "province": "string",
8 "city": "string",
9 "consumerPriceIndexSourceType": "WEB",
10 "source": "string",
11 "formula": "string",
12 "indexedCurrency": true,
13 "exchangeRateType": "string",
14 "erpSystemId": 0,
15 "erpSystemDisplayId": "string",
16 "fromCurrencyId": 0,
17 "fromCurrencyDisplayId": "string",
18 "toCurrencyId": 0,
19 "toCurrencyDisplayId": "string",
20 "consumerPriceIndexValueId": "string",
21 "companyId": 0
22}