Skip to content
/
Bulk write 'Structurereno...

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

Structurerenovationnotation

Operations

List 'Structurerenovationnotation'

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
articleany

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

blocks_errandsany

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

blocks_object_utilizationany

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

buildingany

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

confirmed_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

confirmed_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

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_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

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

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

outdoor_areaany

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

parking_lotany

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

planned_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

planned_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

post_completion_addon_percentageany

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

post_completion_addon_percentage_modeany

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

post_completion_addon_valueany

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

while_active_discount_percentageany

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

while_active_discount_percentage_modeany

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

while_active_discount_valueany

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

curl -i -X GET \
  'https://dev.api.pigello.io/objects/renovation/structurerenovationnotation/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 [
namestring<= 255 charactersrequired
planned_end_datestring(date)required

Additional Validation Information:

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

planned_start_datestring(date)required

Additional Validation Information:

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

idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

post_completion_addon_valuenumber or null(float)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: post_completion_addon_percentage

This value requires that the following fields are also set: article

post_completion_addon_percentage_modeinteger or null(int32)[ -2147483648 .. 2147483647 ]

Additional Validation Information:

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

Enum0123
confirmed_end_datestring or null(date)

Additional Validation Information:

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

confirmed_start_datestring or null(date)

Additional Validation Information:

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

customer_columnsanyread-only
outdoor_areaobject or null(Outdoorarea)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: building, parking_lot

This field, or at least one of the following fields must be set: building, parking_lot

while_active_discount_valuenumber or null(float)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: while_active_discount_percentage

This value requires that the following fields are also set: article

custom_idstring or null<= 128 characters
pending_monitor_approval_amountanyread-only
parking_lotobject or null(Parkinglot)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: building, outdoor_area

This field, or at least one of the following fields must be set: building, outdoor_area

while_active_discount_percentagenumber or null(float)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: while_active_discount_value

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

This value requires that the following fields are also set: article

blocks_errandsboolean
descriptionstring or null
created_atstring(date-time)read-only
articleobject or null(Article)
tagsanyread-only
buildingobject or null(Building)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: parking_lot, outdoor_area

This field, or at least one of the following fields must be set: parking_lot, outdoor_area

organizationobject or null(Organization)
blocks_object_utilizationboolean
post_completion_addon_percentagenumber or null(float)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: post_completion_addon_value

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

This value requires that the following fields are also set: article

while_active_discount_percentage_modeinteger or null(int32)[ -2147483648 .. 2147483647 ]

Additional Validation Information:

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

Enum0123
]
Response
application/json
[
  {
    "post_completion_addon_value": 0.1,
    "post_completion_addon_percentage_mode": 0,
    "name": "string",
    "confirmed_end_date": "2019-08-24",
    "planned_end_date": "2019-08-24",
    "confirmed_start_date": "2019-08-24",
    "customer_columns": null,
    "outdoor_area": { … },
    "while_active_discount_value": 0.1,
    "planned_start_date": "2019-08-24",
    "custom_id": "string",
    "pending_monitor_approval_amount": null,
    "parking_lot": { … },
    "while_active_discount_percentage": 0.1,
    "blocks_errands": true,
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "description": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "article": { … },
    "tags": null,
    "building": { … },
    "organization": { … },
    "blocks_object_utilization": true,
    "post_completion_addon_percentage": 0.1,
    "while_active_discount_percentage_mode": 0
  }
]

Bulk write 'Structurerenovationnotation'

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 [
namestring<= 255 charactersrequired
planned_end_datestring(date)required

Additional Validation Information:

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

planned_start_datestring(date)required

Additional Validation Information:

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

post_completion_addon_valuenumber or null(float)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: post_completion_addon_percentage

This value requires that the following fields are also set: article

post_completion_addon_percentage_modeinteger or null(int32)[ -2147483648 .. 2147483647 ]

Additional Validation Information:

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

Enum0123
confirmed_end_datestring or null(date)

Additional Validation Information:

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

confirmed_start_datestring or null(date)

Additional Validation Information:

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

outdoor_areaobject or null(Outdoorarea)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: building, parking_lot

This field, or at least one of the following fields must be set: building, parking_lot

while_active_discount_valuenumber or null(float)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: while_active_discount_percentage

This value requires that the following fields are also set: article

custom_idstring or null<= 128 characters
parking_lotobject or null(Parkinglot)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: building, outdoor_area

This field, or at least one of the following fields must be set: building, outdoor_area

while_active_discount_percentagenumber or null(float)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: while_active_discount_value

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

This value requires that the following fields are also set: article

blocks_errandsboolean
descriptionstring or null
articleobject or null(Article)
buildingobject or null(Building)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: parking_lot, outdoor_area

This field, or at least one of the following fields must be set: parking_lot, outdoor_area

organizationobject or null(Organization)
blocks_object_utilizationboolean
post_completion_addon_percentagenumber or null(float)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: post_completion_addon_value

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

This value requires that the following fields are also set: article

while_active_discount_percentage_modeinteger or null(int32)[ -2147483648 .. 2147483647 ]

Additional Validation Information:

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

Enum0123
]
curl -i -X POST \
  https://dev.api.pigello.io/objects/renovation/structurerenovationnotation/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 '[
    {
      "post_completion_addon_value": 0.1,
      "post_completion_addon_percentage_mode": 0,
      "name": "string",
      "confirmed_end_date": "2019-08-24",
      "planned_end_date": "2019-08-24",
      "confirmed_start_date": "2019-08-24",
      "outdoor_area": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "while_active_discount_value": 0.1,
      "planned_start_date": "2019-08-24",
      "custom_id": "string",
      "parking_lot": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "while_active_discount_percentage": 0.1,
      "blocks_errands": true,
      "description": "string",
      "article": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "building": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "organization": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "blocks_object_utilization": true,
      "post_completion_addon_percentage": 0.1,
      "while_active_discount_percentage_mode": 0
    }
  ]'

Responses

Successful bulk create/update

Bodyapplication/jsonArray [
namestring<= 255 charactersrequired
planned_end_datestring(date)required

Additional Validation Information:

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

planned_start_datestring(date)required

Additional Validation Information:

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

idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

post_completion_addon_valuenumber or null(float)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: post_completion_addon_percentage

This value requires that the following fields are also set: article

post_completion_addon_percentage_modeinteger or null(int32)[ -2147483648 .. 2147483647 ]

Additional Validation Information:

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

Enum0123
confirmed_end_datestring or null(date)

Additional Validation Information:

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

confirmed_start_datestring or null(date)

Additional Validation Information:

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

customer_columnsanyread-only
outdoor_areaobject or null(Outdoorarea)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: building, parking_lot

This field, or at least one of the following fields must be set: building, parking_lot

while_active_discount_valuenumber or null(float)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: while_active_discount_percentage

This value requires that the following fields are also set: article

custom_idstring or null<= 128 characters
pending_monitor_approval_amountanyread-only
parking_lotobject or null(Parkinglot)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: building, outdoor_area

This field, or at least one of the following fields must be set: building, outdoor_area

while_active_discount_percentagenumber or null(float)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: while_active_discount_value

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

This value requires that the following fields are also set: article

blocks_errandsboolean
descriptionstring or null
created_atstring(date-time)read-only
articleobject or null(Article)
tagsanyread-only
buildingobject or null(Building)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: parking_lot, outdoor_area

This field, or at least one of the following fields must be set: parking_lot, outdoor_area

organizationobject or null(Organization)
blocks_object_utilizationboolean
post_completion_addon_percentagenumber or null(float)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: post_completion_addon_value

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

This value requires that the following fields are also set: article

while_active_discount_percentage_modeinteger or null(int32)[ -2147483648 .. 2147483647 ]

Additional Validation Information:

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

Enum0123
]
Response
application/json
[
  {
    "post_completion_addon_value": 0.1,
    "post_completion_addon_percentage_mode": 0,
    "name": "string",
    "confirmed_end_date": "2019-08-24",
    "planned_end_date": "2019-08-24",
    "confirmed_start_date": "2019-08-24",
    "customer_columns": null,
    "outdoor_area": { … },
    "while_active_discount_value": 0.1,
    "planned_start_date": "2019-08-24",
    "custom_id": "string",
    "pending_monitor_approval_amount": null,
    "parking_lot": { … },
    "while_active_discount_percentage": 0.1,
    "blocks_errands": true,
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "description": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "article": { … },
    "tags": null,
    "building": { … },
    "organization": { … },
    "blocks_object_utilization": true,
    "post_completion_addon_percentage": 0.1,
    "while_active_discount_percentage_mode": 0
  }
]

Spacerenovationnotation

Operations

Taxationsubrecord

Operations

Taxationrecord

Operations

Spacebaserentvatstatusnotation

Operations

Realestatevatkeyquotanotation

Operations

Roomcategory

Operations
© Pigello. All rights reserved.