Skip to content

Objects (2.0.0)

The 'Objects' application of the Core API

Download OpenAPI description
Download Postman Collection
Download OpenAPI Specification (json)
Download OpenAPI Specification (yaml)
Languages
Servers
https://{environment}.pigello.io

Parkingspot

Operations

Apartmenttargetaudience

Operations

Parkingspotvacancynotation

Operations

Industrialpremises

Operations

Industrialpremisesvacancylossnotation

Operations

Industrialpremisestargetaudience

Operations

Outdoorsectionterms

Operations

Industrialpremisesvacancynotation

Operations

Outdoorsectiontargetaudience

Operations

Commonarea

Operations

Industrialpremisesterms

Operations

Parkingspotvacancylossnotation

Operations

Outdoorsectionvacancynotation

Operations

Parkingspottargetaudience

Operations

Apartmentterms

Operations

Apartmentvacancylossnotation

Operations

Outdoorsectionvacancylossnotation

Operations

Parkingspotterms

Operations

Brfapartment

Operations

Create 'Brfapartment'

Request

Security
customer_id and application_id and service_id and service_version_id and client_ct and client_object_id and client_secret
Bodyapplication/json
buildingobject(Building)required
building.​idstring(uuid)
realtor_image_common_info_textstring or null
apartment_idstring or null<= 4 characters'^\d{4}$'
placement_feenumber(float)
investment_capitalnumber(float)
reparation_fund_quota_feesArray of objects(Quotafee)
quotanumber(float)
addressobject or null(Address)
custom_idstring or null<= 128 characters
tempered_areanumber or null(float)
floorsArray of integers or null(int32)unique
categorystring or null<= 64 characters
Enum"PX_1_5_RO""PX_14_ROK""PX_DAILY_OPERATIONS""PX_5_ROKV""PX_GYM""PX_BARN""PX_FINANCIAL_BUILDING""PX_PARKING""PX_CINEMA""PX_STOCK"
reparation_fund_quotanumber or null(float)
landlord_custom_idstring or null<= 255 characters
popular_namestring or null<= 255 characters
usable_areanumber or null(float)
financial_handlerobject or null(Company)
custom_dimension_valuestring or null<= 255 characters
organizationobject or null(Organization)
archivedboolean
bi_areanumber or null(float)
placement_datestring or null(date)
curl -i -X POST \
  https://dev.api.pigello.io/objects/spaces/spaces/brfapartment/ \
  -H 'Content-Type: application/json' \
  -H 'X-PIGELLO-APPLICATION-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-CT: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-ENTITY: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-SECRET: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CUSTOMER-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-VERSION-ID: YOUR_API_KEY_HERE' \
  -d '{
    "realtor_image_common_info_text": "string",
    "apartment_id": "stri",
    "placement_fee": 0.1,
    "investment_capital": 0.1,
    "reparation_fund_quota_fees": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      }
    ],
    "quota": 0.1,
    "address": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "custom_id": "string",
    "tempered_area": 0.1,
    "floors": [
      0
    ],
    "category": "PX_1_5_RO",
    "reparation_fund_quota": 0.1,
    "landlord_custom_id": "string",
    "popular_name": "string",
    "usable_area": 0.1,
    "financial_handler": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "building": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "custom_dimension_value": "string",
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "archived": true,
    "bi_area": 0.1,
    "placement_date": "2019-08-24"
  }'

Responses

Successful creation

Bodyapplication/json
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

buildingobject(Building)required
building.​idstring(uuid)
realtor_image_common_info_textstring or null
apartment_idstring or null<= 4 characters'^\d{4}$'
placement_feenumber(float)
investment_capitalnumber(float)
reparation_fund_quota_feesArray of objects(Quotafee)
quotanumber(float)
addressobject or null(Address)
tenantobject or null(Tenant)read-only
customer_columnsanyread-only
pending_monitor_approval_amountanyread-only
custom_idstring or null<= 128 characters
tempered_areanumber or null(float)
created_atstring(date-time)read-only
floorsArray of integers or null(int32)unique
categorystring or null<= 64 characters
Enum"PX_1_5_RO""PX_14_ROK""PX_DAILY_OPERATIONS""PX_5_ROKV""PX_GYM""PX_BARN""PX_FINANCIAL_BUILDING""PX_PARKING""PX_CINEMA""PX_STOCK"
reparation_fund_quotanumber or null(float)
landlord_custom_idstring or null<= 255 characters
popular_namestring or null<= 255 characters
bi_tenantsArray of objects(Tenant)read-only
usable_areanumber or null(float)
tagsanyread-only
financial_handlerobject or null(Company)
custom_dimension_valuestring or null<= 255 characters
organizationobject or null(Organization)
archivedboolean
bi_areanumber or null(float)
placement_datestring or null(date)
Response
application/json
{
  "realtor_image_common_info_text": "string",
  "apartment_id": "stri",
  "placement_fee": 0.1,
  "investment_capital": 0.1,
  "reparation_fund_quota_fees": [
    { … }
  ],
  "quota": 0.1,
  "address": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "tenant": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "customer_columns": null,
  "pending_monitor_approval_amount": null,
  "custom_id": "string",
  "tempered_area": 0.1,
  "created_at": "2019-08-24T14:15:22Z",
  "floors": [
    0
  ],
  "category": "PX_1_5_RO",
  "reparation_fund_quota": 0.1,
  "landlord_custom_id": "string",
  "popular_name": "string",
  "bi_tenants": [
    { … }
  ],
  "usable_area": 0.1,
  "tags": null,
  "financial_handler": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "building": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "custom_dimension_value": "string",
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "archived": true,
  "bi_area": 0.1,
  "placement_date": "2019-08-24"
}

Delete 'Brfapartment'

Request

Security
customer_id and application_id and service_id and service_version_id and client_ct and client_object_id and client_secret
Path
pkstringwrite-onlyrequired
curl -i -X DELETE \
  'https://dev.api.pigello.io/objects/spaces/spaces/brfapartment/{pk}/' \
  -H 'X-PIGELLO-APPLICATION-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-CT: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-ENTITY: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-SECRET: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CUSTOMER-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-VERSION-ID: YOUR_API_KEY_HERE'

Responses

Successful deletion

Response
No content

Get 'Brfapartment'

Request

Security
customer_id and application_id and service_id and service_version_id and client_ct and client_object_id and client_secret
Path
pkstringwrite-onlyrequired
curl -i -X GET \
  'https://dev.api.pigello.io/objects/spaces/spaces/brfapartment/{pk}/' \
  -H 'X-PIGELLO-APPLICATION-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-CT: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-ENTITY: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-SECRET: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CUSTOMER-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-VERSION-ID: YOUR_API_KEY_HERE'

Responses

Successful selection

Bodyapplication/json
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

buildingobject(Building)required
building.​idstring(uuid)
realtor_image_common_info_textstring or null
apartment_idstring or null<= 4 characters'^\d{4}$'
placement_feenumber(float)
investment_capitalnumber(float)
reparation_fund_quota_feesArray of objects(Quotafee)
quotanumber(float)
addressobject or null(Address)
tenantobject or null(Tenant)read-only
customer_columnsanyread-only
pending_monitor_approval_amountanyread-only
custom_idstring or null<= 128 characters
tempered_areanumber or null(float)
created_atstring(date-time)read-only
floorsArray of integers or null(int32)unique
categorystring or null<= 64 characters
Enum"PX_1_5_RO""PX_14_ROK""PX_DAILY_OPERATIONS""PX_5_ROKV""PX_GYM""PX_BARN""PX_FINANCIAL_BUILDING""PX_PARKING""PX_CINEMA""PX_STOCK"
reparation_fund_quotanumber or null(float)
landlord_custom_idstring or null<= 255 characters
popular_namestring or null<= 255 characters
bi_tenantsArray of objects(Tenant)read-only
usable_areanumber or null(float)
tagsanyread-only
financial_handlerobject or null(Company)
custom_dimension_valuestring or null<= 255 characters
organizationobject or null(Organization)
archivedboolean
bi_areanumber or null(float)
placement_datestring or null(date)
Response
application/json
{
  "realtor_image_common_info_text": "string",
  "apartment_id": "stri",
  "placement_fee": 0.1,
  "investment_capital": 0.1,
  "reparation_fund_quota_fees": [
    { … }
  ],
  "quota": 0.1,
  "address": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "tenant": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "customer_columns": null,
  "pending_monitor_approval_amount": null,
  "custom_id": "string",
  "tempered_area": 0.1,
  "created_at": "2019-08-24T14:15:22Z",
  "floors": [
    0
  ],
  "category": "PX_1_5_RO",
  "reparation_fund_quota": 0.1,
  "landlord_custom_id": "string",
  "popular_name": "string",
  "bi_tenants": [
    { … }
  ],
  "usable_area": 0.1,
  "tags": null,
  "financial_handler": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "building": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "custom_dimension_value": "string",
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "archived": true,
  "bi_area": 0.1,
  "placement_date": "2019-08-24"
}

Apartment

Operations

Apartmentvacancynotation

Operations

Outdoorsection

Operations

Componentmodel

Operations

Componenttype

Operations

Parkinglot

Operations

Realestate

Operations

Building

Operations

Region

Operations

Community

Operations

Outdoorarea

Operations

Structurerenovationnotation

Operations

Spacerenovationnotation

Operations

Taxationsubrecord

Operations

Taxationrecord

Operations

Spacebaserentvatstatusnotation

Operations

Realestatevatkeyquotanotation

Operations

Roomcategory

Operations
© Pigello. All rights reserved.