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

Create 'Outdoorsectiontargetaudience'

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
namestring<= 255 charactersrequired
allow_any_bankruptcyboolean or null
organizationobject or null(Organization)
minimum_previous_year_revenueinteger or null(int32)<= 2147483647
archivedboolean
custom_idstring or null<= 128 characters
maximum_payment_remark_amountinteger or null(int32)<= 2147483647
sni_codesArray of objects or null
minimum_number_of_employeesinteger or null(int32)<= 2147483647

Additional Validation Information:

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

maximum_number_of_employeesinteger or null(int32)<= 2147483647

Additional Validation Information:

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

curl -i -X POST \
  https://dev.api.pigello.io/objects/spaces/targetaudiences/outdoorsectiontargetaudience/ \
  -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 '{
    "allow_any_bankruptcy": true,
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "minimum_previous_year_revenue": 2147483647,
    "archived": true,
    "custom_id": "string",
    "name": "string",
    "maximum_payment_remark_amount": 2147483647,
    "sni_codes": [
      null
    ],
    "minimum_number_of_employees": 2147483647,
    "maximum_number_of_employees": 2147483647
  }'

Responses

Successful creation

Bodyapplication/json
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

namestring<= 255 charactersrequired
allow_any_bankruptcyboolean or null
created_atstring(date-time)read-only
organizationobject or null(Organization)
minimum_previous_year_revenueinteger or null(int32)<= 2147483647
archivedboolean
custom_idstring or null<= 128 characters
customer_columnsanyread-only
tagsanyread-only
maximum_payment_remark_amountinteger or null(int32)<= 2147483647
sni_codesArray of objects or null
minimum_number_of_employeesinteger or null(int32)<= 2147483647

Additional Validation Information:

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

maximum_number_of_employeesinteger or null(int32)<= 2147483647

Additional Validation Information:

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

Response
application/json
{
  "allow_any_bankruptcy": true,
  "created_at": "2019-08-24T14:15:22Z",
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "minimum_previous_year_revenue": 2147483647,
  "archived": true,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "custom_id": "string",
  "customer_columns": null,
  "tags": null,
  "name": "string",
  "maximum_payment_remark_amount": 2147483647,
  "sni_codes": [
    null
  ],
  "minimum_number_of_employees": 2147483647,
  "maximum_number_of_employees": 2147483647
}

Get 'Outdoorsectiontargetaudience'

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/targetaudiences/outdoorsectiontargetaudience/{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

namestring<= 255 charactersrequired
allow_any_bankruptcyboolean or null
created_atstring(date-time)read-only
organizationobject or null(Organization)
minimum_previous_year_revenueinteger or null(int32)<= 2147483647
archivedboolean
custom_idstring or null<= 128 characters
customer_columnsanyread-only
tagsanyread-only
maximum_payment_remark_amountinteger or null(int32)<= 2147483647
sni_codesArray of objects or null
minimum_number_of_employeesinteger or null(int32)<= 2147483647

Additional Validation Information:

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

maximum_number_of_employeesinteger or null(int32)<= 2147483647

Additional Validation Information:

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

Response
application/json
{
  "allow_any_bankruptcy": true,
  "created_at": "2019-08-24T14:15:22Z",
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "minimum_previous_year_revenue": 2147483647,
  "archived": true,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "custom_id": "string",
  "customer_columns": null,
  "tags": null,
  "name": "string",
  "maximum_payment_remark_amount": 2147483647,
  "sni_codes": [
    null
  ],
  "minimum_number_of_employees": 2147483647,
  "maximum_number_of_employees": 2147483647
}

Update 'Outdoorsectiontargetaudience'

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
namestring<= 255 charactersrequired
allow_any_bankruptcyboolean or null
organizationobject or null(Organization)
minimum_previous_year_revenueinteger or null(int32)<= 2147483647
archivedboolean
custom_idstring or null<= 128 characters
maximum_payment_remark_amountinteger or null(int32)<= 2147483647
sni_codesArray of objects or null
minimum_number_of_employeesinteger or null(int32)<= 2147483647

Additional Validation Information:

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

maximum_number_of_employeesinteger or null(int32)<= 2147483647

Additional Validation Information:

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

curl -i -X PATCH \
  'https://dev.api.pigello.io/objects/spaces/targetaudiences/outdoorsectiontargetaudience/{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 '{
    "allow_any_bankruptcy": true,
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "minimum_previous_year_revenue": 2147483647,
    "archived": true,
    "custom_id": "string",
    "name": "string",
    "maximum_payment_remark_amount": 2147483647,
    "sni_codes": [
      null
    ],
    "minimum_number_of_employees": 2147483647,
    "maximum_number_of_employees": 2147483647
  }'

Responses

Successful update

Bodyapplication/json
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

namestring<= 255 charactersrequired
allow_any_bankruptcyboolean or null
created_atstring(date-time)read-only
organizationobject or null(Organization)
minimum_previous_year_revenueinteger or null(int32)<= 2147483647
archivedboolean
custom_idstring or null<= 128 characters
customer_columnsanyread-only
tagsanyread-only
maximum_payment_remark_amountinteger or null(int32)<= 2147483647
sni_codesArray of objects or null
minimum_number_of_employeesinteger or null(int32)<= 2147483647

Additional Validation Information:

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

maximum_number_of_employeesinteger or null(int32)<= 2147483647

Additional Validation Information:

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

Response
application/json
{
  "allow_any_bankruptcy": true,
  "created_at": "2019-08-24T14:15:22Z",
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "minimum_previous_year_revenue": 2147483647,
  "archived": true,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "custom_id": "string",
  "customer_columns": null,
  "tags": null,
  "name": "string",
  "maximum_payment_remark_amount": 2147483647,
  "sni_codes": [
    null
  ],
  "minimum_number_of_employees": 2147483647,
  "maximum_number_of_employees": 2147483647
}

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

Spacerenovationnotation

Operations

Taxationsubrecord

Operations

Taxationrecord

Operations

Spacebaserentvatstatusnotation

Operations

Realestatevatkeyquotanotation

Operations

Roomcategory

Operations
© Pigello. All rights reserved.