Component

Operations

List 'Component'

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 any

global_realestatesArray of any

global_segmentsArray of any

tagsArray of any

tags!Array of any

apartmentany

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

brf_apartmentany

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

common_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

component_modelany

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

component_typeany

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

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

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

industrial_premisesany

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

installation_timeany

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

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

outdoor_sectionany

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

parking_spotany

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

purchase_source_webpageany

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

purchase_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

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

responsible_external_supplierany

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

roomany

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

serial_numberany

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

uninstallation_timeany

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

warranty_expiration_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

warranty_warning_interval_weeksany

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

write_off_monthsany

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

write_off_warning_interval_weeksany

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

GET

/objects/components/component/list/

curl -i -X GET \
  'https://dev.api.pigello.io/objects/components/component/list/?_jsonl=true&_order_by=field_a%2C-field_b&_page=1&_page_size=0&_search=string&_slim=true&_statistics=true&customer_columns=&global_realestates=&global_segments=&tags=&tags!=&apartment=%7Bapartment%7D&brf_apartment=%7Bbrf_apartment%7D&building=%7Bbuilding%7D&common_area=%7Bcommon_area%7D&component_model=%7Bcomponent_model%7D&component_type=%7Bcomponent_type%7D&created_at=%7Bcreated_at%7D&custom_id=%7Bcustom_id%7D&id=%7Bid%7D&industrial_premises=%7Bindustrial_premises%7D&installation_time=%7Binstallation_time%7D&name=%7Bname%7D&organization=%7Borganization%7D&outdoor_area=%7Boutdoor_area%7D&outdoor_section=%7Boutdoor_section%7D&parking_lot=%7Bparking_lot%7D&parking_spot=%7Bparking_spot%7D&purchase_source_webpage=%7Bpurchase_source_webpage%7D&purchase_value=%7Bpurchase_value%7D&realestate=%7Brealestate%7D&responsible_external_supplier=%7Bresponsible_external_supplier%7D&room=%7Broom%7D&serial_number=%7Bserial_number%7D&uninstallation_time=%7Buninstallation_time%7D&warranty_expiration_date=%7Bwarranty_expiration_date%7D&warranty_warning_interval_weeks=%7Bwarranty_warning_interval_weeks%7D&write_off_months=%7Bwrite_off_months%7D&write_off_warning_interval_weeks=%7Bwrite_off_warning_interval_weeks%7D' \
  -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/json

Array [

idstring, (uuid)read-onlyrequired

Additional Validation Information:

Must be unique

namestring, <= 255 charactersrequired

parking_spotobject or null(Parkingspot)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: room, apartment, brf_apartment, industrial_premises, common_area, outdoor_section, building, parking_lot, outdoor_area, realestate

This field, or at least one of the following fields must be set: room, apartment, brf_apartment, industrial_premises, common_area, outdoor_section, building, parking_lot, outdoor_area, realestate

custom_idstring or null, <= 128 characters

warranty_warning_interval_weeksinteger or null, (int32), [ 1 .. 2147483647 ]

Additional Validation Information:

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

warranty_expiration_datestring or null, (date)

Additional Validation Information:

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

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

buildingobject or null(Building)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: room, apartment, brf_apartment, industrial_premises, common_area, parking_spot, outdoor_section, parking_lot, outdoor_area, realestate

This field, or at least one of the following fields must be set: room, apartment, brf_apartment, industrial_premises, common_area, parking_spot, outdoor_section, parking_lot, outdoor_area, realestate

write_off_warning_interval_weeksinteger or null, (int32), [ 1 .. 2147483647 ]

Additional Validation Information:

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

common_areaobject or null(Commonarea)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: room, apartment, brf_apartment, industrial_premises, parking_spot, outdoor_section, building, parking_lot, outdoor_area, realestate

This field, or at least one of the following fields must be set: room, apartment, brf_apartment, industrial_premises, parking_spot, outdoor_section, building, parking_lot, outdoor_area, realestate

component_typeobject or null(Componenttype)

customer_columnsanyread-only

write_off_monthsinteger or null, (int32), [ 1 .. 2147483647 ]

Additional Validation Information:

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

organizationobject or null(Organization)

roomobject or null(Room)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment, brf_apartment, industrial_premises, common_area, parking_spot, outdoor_section, building, parking_lot, outdoor_area, realestate

This field, or at least one of the following fields must be set: apartment, brf_apartment, industrial_premises, common_area, parking_spot, outdoor_section, building, parking_lot, outdoor_area, realestate

purchase_valuenumber or null, (float)

parking_lotobject or null(Parkinglot)

Additional Validation Information:

created_atstring, (date-time)read-only

uninstallation_timestring or null, (date-time)

Additional Validation Information:

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

realestateobject or null(Realestate)

Additional Validation Information:

outdoor_areaobject or null(Outdoorarea)

Additional Validation Information:

responsible_external_supplierobject or null(Externalsupplier)

outdoor_sectionobject or null(Outdoorsection)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: room, apartment, brf_apartment, industrial_premises, common_area, parking_spot, building, parking_lot, outdoor_area, realestate

This field, or at least one of the following fields must be set: room, apartment, brf_apartment, industrial_premises, common_area, parking_spot, building, parking_lot, outdoor_area, realestate

tagsanyread-only

serial_numberstring or null, <= 255 characters

pending_monitor_approval_amountanyread-only

purchase_source_webpagestring or null, (url), <= 200 characters

apartmentobject or null(Apartment)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: room, brf_apartment, industrial_premises, common_area, parking_spot, outdoor_section, building, parking_lot, outdoor_area, realestate

This field, or at least one of the following fields must be set: room, brf_apartment, industrial_premises, common_area, parking_spot, outdoor_section, building, parking_lot, outdoor_area, realestate

component_modelobject or null(Componentmodel)

brf_apartmentobject or null(Brfapartment)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: room, apartment, industrial_premises, common_area, parking_spot, outdoor_section, building, parking_lot, outdoor_area, realestate

This field, or at least one of the following fields must be set: room, apartment, industrial_premises, common_area, parking_spot, outdoor_section, building, parking_lot, outdoor_area, realestate

installation_timestring or null, (date-time)

Additional Validation Information:

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

industrial_premisesobject or null(Industrialpremises)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: room, apartment, brf_apartment, common_area, parking_spot, outdoor_section, building, parking_lot, outdoor_area, realestate

This field, or at least one of the following fields must be set: room, apartment, brf_apartment, common_area, parking_spot, outdoor_section, building, parking_lot, outdoor_area, realestate

]

Response

[
  {
    "parking_spot": { … },
    "custom_id": "string",
    "warranty_warning_interval_weeks": 1,
    "warranty_expiration_date": "2019-08-24",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "building": { … },
    "write_off_warning_interval_weeks": 1,
    "common_area": { … },
    "component_type": { … },
    "customer_columns": null,
    "write_off_months": 1,
    "organization": { … },
    "room": { … },
    "purchase_value": 0.1,
    "parking_lot": { … },
    "created_at": "2019-08-24T14:15:22Z",
    "uninstallation_time": "2019-08-24T14:15:22Z",
    "realestate": { … },
    "outdoor_area": { … },
    "responsible_external_supplier": { … },
    "outdoor_section": { … },
    "tags": null,
    "serial_number": "string",
    "name": "string",
    "pending_monitor_approval_amount": null,
    "purchase_source_webpage": "string",
    "apartment": { … },
    "component_model": { … },
    "brf_apartment": { … },
    "installation_time": "2019-08-24T14:15:22Z",
    "industrial_premises": { … }
  }
]

Component

List 'Component'

Request

Query

Responses

Was this helpful?