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

Delete 'Parkingspotvacancylossnotation'

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/vacancies/parkingspotvacancylossnotation/{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

Update 'Parkingspotvacancylossnotation'

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
Bodyapplication/json
valuenumber(float)required
vatinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum025126
titlestring<= 255 charactersrequired
vacancy_notationobject(Parkingspotvacancynotation)required
vacancy_notation.​idstring(uuid)
articleobject(Article)required
article.​idstring(uuid)
indexation_value_quotanumber or null(float)

Additional Validation Information:

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

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

source_row_object_idstring or null(uuid)

Additional Validation Information:

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

organizationobject or null(Organization)
indexation_base_yearinteger or null(int32)[ 1900 .. 9000 ]

Additional Validation Information:

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

indexation_firm_valuenumber or null(float)

Additional Validation Information:

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

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

custom_idstring or null<= 128 characters
end_datestring or null(date)

Additional Validation Information:

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

indexation_settingobject or null(Indexationsetting)

Additional Validation Information:

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

start_datestring or null(date)

Additional Validation Information:

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

source_row_content_typeobject or null(Contenttype)

Additional Validation Information:

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

custom_dimension_valuestring or null<= 255 characters
curl -i -X PATCH \
  'https://dev.api.pigello.io/objects/spaces/vacancies/parkingspotvacancylossnotation/{pk}/' \
  -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 '{
    "value": 0.1,
    "indexation_value_quota": 0.1,
    "source_row_object_id": "d44585c8-7939-493c-aafc-e82e4822bf7c",
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "indexation_base_year": 1900,
    "indexation_firm_value": 0.1,
    "custom_id": "string",
    "end_date": "2019-08-24",
    "vat": 0,
    "indexation_setting": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "title": "string",
    "start_date": "2019-08-24",
    "vacancy_notation": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "article": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "source_row_content_type": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "custom_dimension_value": "string"
  }'

Responses

Successful update

Bodyapplication/json
valuenumber(float)required
vatinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum025126
titlestring<= 255 charactersrequired
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

vacancy_notationobject(Parkingspotvacancynotation)required
vacancy_notation.​idstring(uuid)
articleobject(Article)required
article.​idstring(uuid)
created_atstring(date-time)read-only
indexation_value_quotanumber or null(float)

Additional Validation Information:

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

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

source_row_object_idstring or null(uuid)

Additional Validation Information:

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

organizationobject or null(Organization)
indexation_base_yearinteger or null(int32)[ 1900 .. 9000 ]

Additional Validation Information:

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

indexation_firm_valuenumber or null(float)

Additional Validation Information:

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

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

custom_idstring or null<= 128 characters
end_datestring or null(date)

Additional Validation Information:

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

indexation_settingobject or null(Indexationsetting)

Additional Validation Information:

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

start_datestring or null(date)

Additional Validation Information:

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

source_row_content_typeobject or null(Contenttype)

Additional Validation Information:

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

custom_dimension_valuestring or null<= 255 characters
Response
application/json
{
  "value": 0.1,
  "created_at": "2019-08-24T14:15:22Z",
  "indexation_value_quota": 0.1,
  "source_row_object_id": "d44585c8-7939-493c-aafc-e82e4822bf7c",
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "indexation_base_year": 1900,
  "indexation_firm_value": 0.1,
  "custom_id": "string",
  "end_date": "2019-08-24",
  "vat": 0,
  "indexation_setting": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "title": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "start_date": "2019-08-24",
  "vacancy_notation": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "article": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "source_row_content_type": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "custom_dimension_value": "string"
}

Get 'Parkingspotvacancylossnotation'

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/vacancies/parkingspotvacancylossnotation/{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
valuenumber(float)required
vatinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum025126
titlestring<= 255 charactersrequired
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

vacancy_notationobject(Parkingspotvacancynotation)required
vacancy_notation.​idstring(uuid)
articleobject(Article)required
article.​idstring(uuid)
created_atstring(date-time)read-only
indexation_value_quotanumber or null(float)

Additional Validation Information:

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

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

source_row_object_idstring or null(uuid)

Additional Validation Information:

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

organizationobject or null(Organization)
indexation_base_yearinteger or null(int32)[ 1900 .. 9000 ]

Additional Validation Information:

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

indexation_firm_valuenumber or null(float)

Additional Validation Information:

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

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

custom_idstring or null<= 128 characters
end_datestring or null(date)

Additional Validation Information:

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

indexation_settingobject or null(Indexationsetting)

Additional Validation Information:

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

start_datestring or null(date)

Additional Validation Information:

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

source_row_content_typeobject or null(Contenttype)

Additional Validation Information:

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

custom_dimension_valuestring or null<= 255 characters
Response
application/json
{
  "value": 0.1,
  "created_at": "2019-08-24T14:15:22Z",
  "indexation_value_quota": 0.1,
  "source_row_object_id": "d44585c8-7939-493c-aafc-e82e4822bf7c",
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "indexation_base_year": 1900,
  "indexation_firm_value": 0.1,
  "custom_id": "string",
  "end_date": "2019-08-24",
  "vat": 0,
  "indexation_setting": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "title": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "start_date": "2019-08-24",
  "vacancy_notation": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "article": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "source_row_content_type": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "custom_dimension_value": "string"
}

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

Spacerenovationnotation

Operations

Taxationsubrecord

Operations

Taxationrecord

Operations

Spacebaserentvatstatusnotation

Operations

Realestatevatkeyquotanotation

Operations

Roomcategory

Operations
© Pigello. All rights reserved.