Skip to content
/
Bulk write 'Outdoorarea'

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

Apartment

Operations

Apartmentvacancynotation

Operations

Outdoorsection

Operations

Componentmodel

Operations

Componenttype

Operations

Parkinglot

Operations

Realestate

Operations

Building

Operations

Region

Operations

Community

Operations

Outdoorarea

Operations

Create 'Outdoorarea'

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
realestateobject(Realestate)required
realestate.​idstring(uuid)
namestring<= 255 charactersrequired
structure_operation_typeinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum012346891920
built_datestring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: availability_start_date, demolition_date, availability_end_date

registered_bi_areanumber or null(float)

Additional Validation Information:

This value must be set with a proper magnitude, in relation to the following fields: registered_gross_area

organizationobject or null(Organization)
availability_start_datestring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: demolition_date, built_date, availability_end_date

registered_building_areanumber or null(float)
public_descriptionstring or null
demolition_datestring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: availability_start_date, built_date, availability_end_date

registered_usable_areanumber or null(float)

Additional Validation Information:

This value must be set with a proper magnitude, in relation to the following fields: registered_gross_area

availability_end_datestring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: availability_start_date, demolition_date, built_date

registered_gross_areanumber or null(float)

Additional Validation Information:

This value must be set with a proper magnitude, in relation to the following fields: registered_bi_area, registered_usable_area

structure_typestring or null<= 64 characters
Enum"CCD""CAQ""CAE""DEE""CAL""DBA""DCA""DEH""CAJ""CAF"
addressobject or null(Address)
custom_dimension_valuestring or null<= 255 characters
custom_idstring or null<= 128 characters
sales_descriptionstring or null
curl -i -X POST \
  https://dev.api.pigello.io/objects/structural/outdoorarea/ \
  -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 '{
    "structure_operation_type": 0,
    "realestate": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "built_date": "2019-08-24",
    "registered_bi_area": 0.1,
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "availability_start_date": "2019-08-24",
    "registered_building_area": 0.1,
    "public_description": "string",
    "demolition_date": "2019-08-24",
    "registered_usable_area": 0.1,
    "availability_end_date": "2019-08-24",
    "registered_gross_area": 0.1,
    "structure_type": "CCD",
    "address": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "custom_dimension_value": "string",
    "custom_id": "string",
    "name": "string",
    "sales_description": "string"
  }'

Responses

Successful creation

Bodyapplication/json
realestateobject(Realestate)required
realestate.​idstring(uuid)
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

namestring<= 255 charactersrequired
calculated_bi_areanumber(float)read-only
calculated_bi_area_rentable_base_rent_vatnumber(float)read-only
tagsanyread-only
structure_operation_typeinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum012346891920
built_datestring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: availability_start_date, demolition_date, availability_end_date

customer_columnsanyread-only
registered_bi_areanumber or null(float)

Additional Validation Information:

This value must be set with a proper magnitude, in relation to the following fields: registered_gross_area

organizationobject or null(Organization)
pending_monitor_approval_amountanyread-only
calculated_usable_areanumber(float)read-only
availability_start_datestring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: demolition_date, built_date, availability_end_date

registered_building_areanumber or null(float)
public_descriptionstring or null
calculated_usable_area_rentable_base_rent_vatnumber(float)read-only
demolition_datestring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: availability_start_date, built_date, availability_end_date

registered_usable_areanumber or null(float)

Additional Validation Information:

This value must be set with a proper magnitude, in relation to the following fields: registered_gross_area

calculated_usable_area_rentablenumber(float)read-only
availability_end_datestring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: availability_start_date, demolition_date, built_date

registered_gross_areanumber or null(float)

Additional Validation Information:

This value must be set with a proper magnitude, in relation to the following fields: registered_bi_area, registered_usable_area

calculated_bi_area_rentablenumber(float)read-only
structure_typestring or null<= 64 characters
Enum"CCD""CAQ""CAE""DEE""CAL""DBA""DCA""DEH""CAJ""CAF"
addressobject or null(Address)
custom_dimension_valuestring or null<= 255 characters
custom_idstring or null<= 128 characters
sales_descriptionstring or null
created_atstring(date-time)read-only
Response
application/json
{
  "calculated_bi_area": 0.1,
  "calculated_bi_area_rentable_base_rent_vat": 0.1,
  "tags": null,
  "structure_operation_type": 0,
  "realestate": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "built_date": "2019-08-24",
  "customer_columns": null,
  "registered_bi_area": 0.1,
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "pending_monitor_approval_amount": null,
  "calculated_usable_area": 0.1,
  "availability_start_date": "2019-08-24",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "registered_building_area": 0.1,
  "public_description": "string",
  "calculated_usable_area_rentable_base_rent_vat": 0.1,
  "demolition_date": "2019-08-24",
  "registered_usable_area": 0.1,
  "calculated_usable_area_rentable": 0.1,
  "availability_end_date": "2019-08-24",
  "registered_gross_area": 0.1,
  "calculated_bi_area_rentable": 0.1,
  "structure_type": "CCD",
  "address": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "custom_dimension_value": "string",
  "custom_id": "string",
  "name": "string",
  "sales_description": "string",
  "created_at": "2019-08-24T14:15:22Z"
}

Bulk write 'Outdoorarea'

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/jsonArray [
realestateobject(Realestate)required
realestate.​idstring(uuid)
namestring<= 255 charactersrequired
structure_operation_typeinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum012346891920
built_datestring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: availability_start_date, demolition_date, availability_end_date

registered_bi_areanumber or null(float)

Additional Validation Information:

This value must be set with a proper magnitude, in relation to the following fields: registered_gross_area

organizationobject or null(Organization)
availability_start_datestring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: demolition_date, built_date, availability_end_date

registered_building_areanumber or null(float)
public_descriptionstring or null
demolition_datestring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: availability_start_date, built_date, availability_end_date

registered_usable_areanumber or null(float)

Additional Validation Information:

This value must be set with a proper magnitude, in relation to the following fields: registered_gross_area

availability_end_datestring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: availability_start_date, demolition_date, built_date

registered_gross_areanumber or null(float)

Additional Validation Information:

This value must be set with a proper magnitude, in relation to the following fields: registered_bi_area, registered_usable_area

structure_typestring or null<= 64 characters
Enum"CCD""CAQ""CAE""DEE""CAL""DBA""DCA""DEH""CAJ""CAF"
addressobject or null(Address)
custom_dimension_valuestring or null<= 255 characters
custom_idstring or null<= 128 characters
sales_descriptionstring or null
]
curl -i -X POST \
  https://dev.api.pigello.io/objects/structural/outdoorarea/list/ \
  -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 '[
    {
      "structure_operation_type": 0,
      "realestate": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "built_date": "2019-08-24",
      "registered_bi_area": 0.1,
      "organization": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "availability_start_date": "2019-08-24",
      "registered_building_area": 0.1,
      "public_description": "string",
      "demolition_date": "2019-08-24",
      "registered_usable_area": 0.1,
      "availability_end_date": "2019-08-24",
      "registered_gross_area": 0.1,
      "structure_type": "CCD",
      "address": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "custom_dimension_value": "string",
      "custom_id": "string",
      "name": "string",
      "sales_description": "string"
    }
  ]'

Responses

Successful bulk create/update

Bodyapplication/jsonArray [
realestateobject(Realestate)required
realestate.​idstring(uuid)
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

namestring<= 255 charactersrequired
calculated_bi_areanumber(float)read-only
calculated_bi_area_rentable_base_rent_vatnumber(float)read-only
tagsanyread-only
structure_operation_typeinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum012346891920
built_datestring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: availability_start_date, demolition_date, availability_end_date

customer_columnsanyread-only
registered_bi_areanumber or null(float)

Additional Validation Information:

This value must be set with a proper magnitude, in relation to the following fields: registered_gross_area

organizationobject or null(Organization)
pending_monitor_approval_amountanyread-only
calculated_usable_areanumber(float)read-only
availability_start_datestring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: demolition_date, built_date, availability_end_date

registered_building_areanumber or null(float)
public_descriptionstring or null
calculated_usable_area_rentable_base_rent_vatnumber(float)read-only
demolition_datestring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: availability_start_date, built_date, availability_end_date

registered_usable_areanumber or null(float)

Additional Validation Information:

This value must be set with a proper magnitude, in relation to the following fields: registered_gross_area

calculated_usable_area_rentablenumber(float)read-only
availability_end_datestring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: availability_start_date, demolition_date, built_date

registered_gross_areanumber or null(float)

Additional Validation Information:

This value must be set with a proper magnitude, in relation to the following fields: registered_bi_area, registered_usable_area

calculated_bi_area_rentablenumber(float)read-only
structure_typestring or null<= 64 characters
Enum"CCD""CAQ""CAE""DEE""CAL""DBA""DCA""DEH""CAJ""CAF"
addressobject or null(Address)
custom_dimension_valuestring or null<= 255 characters
custom_idstring or null<= 128 characters
sales_descriptionstring or null
created_atstring(date-time)read-only
]
Response
application/json
[
  {
    "calculated_bi_area": 0.1,
    "calculated_bi_area_rentable_base_rent_vat": 0.1,
    "tags": null,
    "structure_operation_type": 0,
    "realestate": { … },
    "built_date": "2019-08-24",
    "customer_columns": null,
    "registered_bi_area": 0.1,
    "organization": { … },
    "pending_monitor_approval_amount": null,
    "calculated_usable_area": 0.1,
    "availability_start_date": "2019-08-24",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "registered_building_area": 0.1,
    "public_description": "string",
    "calculated_usable_area_rentable_base_rent_vat": 0.1,
    "demolition_date": "2019-08-24",
    "registered_usable_area": 0.1,
    "calculated_usable_area_rentable": 0.1,
    "availability_end_date": "2019-08-24",
    "registered_gross_area": 0.1,
    "calculated_bi_area_rentable": 0.1,
    "structure_type": "CCD",
    "address": { … },
    "custom_dimension_value": "string",
    "custom_id": "string",
    "name": "string",
    "sales_description": "string",
    "created_at": "2019-08-24T14:15:22Z"
  }
]

List 'Outdoorarea'

Request

Security
customer_id and application_id and service_id and service_version_id and client_ct and client_object_id and client_secret
Query
_jsonlboolean
_order_byArray of strings
Example: _order_by=field_a,-field_b
_pageinteger(int32)>= 1

Additional Validation Information:

This value must be set together with the following fields: _page_size

_page_sizeinteger(int32)

Additional Validation Information:

This value must be set together with the following fields: _page

_searchstring
_slimboolean
_statisticsboolean
customer_columnsArray of objects
global_realestatesArray of objects
global_segmentsArray of objects
tagsArray of objects
addressany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

availability_end_dateany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: gt, Supports negation (via !): True

Operator: gte, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: lt, Supports negation (via !): True

Operator: lte, Supports negation (via !): True

availability_start_dateany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: gt, Supports negation (via !): True

Operator: gte, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: lt, Supports negation (via !): True

Operator: lte, Supports negation (via !): True

built_dateany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: gt, Supports negation (via !): True

Operator: gte, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: lt, Supports negation (via !): True

Operator: lte, Supports negation (via !): True

calculated_bi_areaany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: gt, Supports negation (via !): True

Operator: gte, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: lt, Supports negation (via !): True

Operator: lte, Supports negation (via !): True

calculated_bi_area_rentableany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: gt, Supports negation (via !): True

Operator: gte, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: lt, Supports negation (via !): True

Operator: lte, Supports negation (via !): True

calculated_bi_area_rentable_base_rent_vatany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: gt, Supports negation (via !): True

Operator: gte, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: lt, Supports negation (via !): True

Operator: lte, Supports negation (via !): True

calculated_usable_areaany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: gt, Supports negation (via !): True

Operator: gte, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: lt, Supports negation (via !): True

Operator: lte, Supports negation (via !): True

calculated_usable_area_rentableany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: gt, Supports negation (via !): True

Operator: gte, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: lt, Supports negation (via !): True

Operator: lte, Supports negation (via !): True

calculated_usable_area_rentable_base_rent_vatany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: gt, Supports negation (via !): True

Operator: gte, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: lt, Supports negation (via !): True

Operator: lte, Supports negation (via !): True

created_atany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: gt, Supports negation (via !): True

Operator: gte, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: lt, Supports negation (via !): True

Operator: lte, Supports negation (via !): True

custom_dimension_valueany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: contains, Supports negation (via !): True

Operator: endswith, Supports negation (via !): True

Operator: icontains, Supports negation (via !): True

Operator: iendswith, Supports negation (via !): True

Operator: iexact, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: istartswith, Supports negation (via !): True

Operator: startswith, Supports negation (via !): True

custom_idany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: contains, Supports negation (via !): True

Operator: endswith, Supports negation (via !): True

Operator: icontains, Supports negation (via !): True

Operator: iendswith, Supports negation (via !): True

Operator: iexact, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: istartswith, Supports negation (via !): True

Operator: startswith, Supports negation (via !): True

demolition_dateany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: gt, Supports negation (via !): True

Operator: gte, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: lt, Supports negation (via !): True

Operator: lte, Supports negation (via !): True

idany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

nameany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: contains, Supports negation (via !): True

Operator: endswith, Supports negation (via !): True

Operator: icontains, Supports negation (via !): True

Operator: iendswith, Supports negation (via !): True

Operator: iexact, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: istartswith, Supports negation (via !): True

Operator: startswith, Supports negation (via !): True

organizationany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

public_descriptionany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: contains, Supports negation (via !): True

Operator: endswith, Supports negation (via !): True

Operator: icontains, Supports negation (via !): True

Operator: iendswith, Supports negation (via !): True

Operator: iexact, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: istartswith, Supports negation (via !): True

Operator: startswith, Supports negation (via !): True

realestateany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

registered_bi_areaany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: gt, Supports negation (via !): True

Operator: gte, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: lt, Supports negation (via !): True

Operator: lte, Supports negation (via !): True

registered_building_areaany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: gt, Supports negation (via !): True

Operator: gte, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: lt, Supports negation (via !): True

Operator: lte, Supports negation (via !): True

registered_gross_areaany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: gt, Supports negation (via !): True

Operator: gte, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: lt, Supports negation (via !): True

Operator: lte, Supports negation (via !): True

registered_usable_areaany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: gt, Supports negation (via !): True

Operator: gte, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: lt, Supports negation (via !): True

Operator: lte, Supports negation (via !): True

sales_descriptionany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: contains, Supports negation (via !): True

Operator: endswith, Supports negation (via !): True

Operator: icontains, Supports negation (via !): True

Operator: iendswith, Supports negation (via !): True

Operator: iexact, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: istartswith, Supports negation (via !): True

Operator: startswith, Supports negation (via !): True

structure_operation_typeany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: gt, Supports negation (via !): True

Operator: gte, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: lt, Supports negation (via !): True

Operator: lte, Supports negation (via !): True

structure_typeany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: contains, Supports negation (via !): True

Operator: endswith, Supports negation (via !): True

Operator: icontains, Supports negation (via !): True

Operator: iendswith, Supports negation (via !): True

Operator: iexact, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: istartswith, Supports negation (via !): True

Operator: startswith, Supports negation (via !): True

curl -i -X GET \
  'https://dev.api.pigello.io/objects/structural/outdoorarea/list/?_jsonl=true&_order_by=field_a%2C-field_b&_page=1&_page_size=0&_search=string&_slim=true&_statistics=true' \
  -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 query

Bodyapplication/jsonArray [
realestateobject(Realestate)required
realestate.​idstring(uuid)
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

namestring<= 255 charactersrequired
calculated_bi_areanumber(float)read-only
calculated_bi_area_rentable_base_rent_vatnumber(float)read-only
tagsanyread-only
structure_operation_typeinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum012346891920
built_datestring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: availability_start_date, demolition_date, availability_end_date

customer_columnsanyread-only
registered_bi_areanumber or null(float)

Additional Validation Information:

This value must be set with a proper magnitude, in relation to the following fields: registered_gross_area

organizationobject or null(Organization)
pending_monitor_approval_amountanyread-only
calculated_usable_areanumber(float)read-only
availability_start_datestring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: demolition_date, built_date, availability_end_date

registered_building_areanumber or null(float)
public_descriptionstring or null
calculated_usable_area_rentable_base_rent_vatnumber(float)read-only
demolition_datestring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: availability_start_date, built_date, availability_end_date

registered_usable_areanumber or null(float)

Additional Validation Information:

This value must be set with a proper magnitude, in relation to the following fields: registered_gross_area

calculated_usable_area_rentablenumber(float)read-only
availability_end_datestring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: availability_start_date, demolition_date, built_date

registered_gross_areanumber or null(float)

Additional Validation Information:

This value must be set with a proper magnitude, in relation to the following fields: registered_bi_area, registered_usable_area

calculated_bi_area_rentablenumber(float)read-only
structure_typestring or null<= 64 characters
Enum"CCD""CAQ""CAE""DEE""CAL""DBA""DCA""DEH""CAJ""CAF"
addressobject or null(Address)
custom_dimension_valuestring or null<= 255 characters
custom_idstring or null<= 128 characters
sales_descriptionstring or null
created_atstring(date-time)read-only
]
Response
application/json
[
  {
    "calculated_bi_area": 0.1,
    "calculated_bi_area_rentable_base_rent_vat": 0.1,
    "tags": null,
    "structure_operation_type": 0,
    "realestate": { … },
    "built_date": "2019-08-24",
    "customer_columns": null,
    "registered_bi_area": 0.1,
    "organization": { … },
    "pending_monitor_approval_amount": null,
    "calculated_usable_area": 0.1,
    "availability_start_date": "2019-08-24",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "registered_building_area": 0.1,
    "public_description": "string",
    "calculated_usable_area_rentable_base_rent_vat": 0.1,
    "demolition_date": "2019-08-24",
    "registered_usable_area": 0.1,
    "calculated_usable_area_rentable": 0.1,
    "availability_end_date": "2019-08-24",
    "registered_gross_area": 0.1,
    "calculated_bi_area_rentable": 0.1,
    "structure_type": "CCD",
    "address": { … },
    "custom_dimension_value": "string",
    "custom_id": "string",
    "name": "string",
    "sales_description": "string",
    "created_at": "2019-08-24T14:15:22Z"
  }
]

Structurerenovationnotation

Operations

Spacerenovationnotation

Operations

Taxationsubrecord

Operations

Taxationrecord

Operations

Spacebaserentvatstatusnotation

Operations

Realestatevatkeyquotanotation

Operations

Roomcategory

Operations
© Pigello. All rights reserved.