Skip to content

Get '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
Path
pkstringwrite-onlyrequired
GET
/objects/components/component/{pk}/
curl -i -X GET \
  'https://dev.api.pigello.io/objects/components/component/{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
organizationobject or null(Organization)
custom_idstring or null, <= 128 characters
created_atstring, (date-time)read-only
serial_numberstring or null, <= 255 characters
component_typeobject or null(ComponentType)
component_modelobject or null(ComponentModel)
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

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

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

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

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

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

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

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

parking_lotobject or null(ParkingLot)

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, building, 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, building, outdoor_area, realestate

outdoor_areaobject or null(OutdoorArea)

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, building, parking_lot, 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, building, parking_lot, realestate

realestateobject or null(RealEstate)

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, building, parking_lot, outdoor_area

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, building, parking_lot, outdoor_area

installation_timestring or null, (date-time)

Additional Validation Information:

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

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

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

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

Additional Validation Information:

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

responsible_external_supplierobject or null(ExternalSupplier)
purchase_valuenumber or null, (float)
purchase_source_webpagestring or null, (url), <= 200 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

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

tagsanyread-only
customer_columnsanyread-only
pending_monitor_approval_amountanyread-only
Response
{
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "custom_id": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "name": "string",
  "serial_number": "string",
  "component_type": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "component_model": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "room": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "apartment": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "brf_apartment": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "industrial_premises": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "common_area": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "parking_spot": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "outdoor_section": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "building": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "parking_lot": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "outdoor_area": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "realestate": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "installation_time": "2019-08-24T14:15:22Z",
  "uninstallation_time": "2019-08-24T14:15:22Z",
  "warranty_expiration_date": "2019-08-24",
  "write_off_months": 1,
  "responsible_external_supplier": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "purchase_value": 0.1,
  "purchase_source_webpage": "string",
  "warranty_warning_interval_weeks": 1,
  "write_off_warning_interval_weeks": 1,
  "tags": null,
  "customer_columns": null,
  "pending_monitor_approval_amount": null
}
© Pigello. All rights reserved.