Skip to content

Measurements (2.0.0)

The 'Measurements' 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

Priceitem

Operations

Pricegroup

Operations

Sensorspecification

Operations

Pricegrouponlyenabledfor

Operations

List 'Pricegrouponlyenabledfor'

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

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

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

price_groupany

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

curl -i -X GET \
  'https://dev.api.pigello.io/measurements/sensors/pricegrouponlyenabledfor/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 [
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

price_groupobject(Pricegroup)required
price_group.​idstring(uuid)
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

created_atstring(date-time)read-only
custom_idstring or null<= 128 characters
tagsanyread-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

organizationobject or null(Organization)
customer_columnsanyread-only
buildingobject or null(Building)

Additional Validation Information:

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

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

]
Response
application/json
[
  {
    "outdoor_area": { … },
    "created_at": "2019-08-24T14:15:22Z",
    "custom_id": "string",
    "tags": null,
    "parking_lot": { … },
    "organization": { … },
    "customer_columns": null,
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "building": { … },
    "price_group": { … }
  }
]

Bulk write 'Pricegrouponlyenabledfor'

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 [
price_groupobject(Pricegroup)required
price_group.​idstring(uuid)
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

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

organizationobject or null(Organization)
buildingobject or null(Building)

Additional Validation Information:

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

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

]
curl -i -X POST \
  https://dev.api.pigello.io/measurements/sensors/pricegrouponlyenabledfor/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 '[
    {
      "outdoor_area": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "custom_id": "string",
      "parking_lot": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "organization": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "building": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "price_group": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      }
    }
  ]'

Responses

Successful bulk create/update

Bodyapplication/jsonArray [
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

price_groupobject(Pricegroup)required
price_group.​idstring(uuid)
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

created_atstring(date-time)read-only
custom_idstring or null<= 128 characters
tagsanyread-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

organizationobject or null(Organization)
customer_columnsanyread-only
buildingobject or null(Building)

Additional Validation Information:

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

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

]
Response
application/json
[
  {
    "outdoor_area": { … },
    "created_at": "2019-08-24T14:15:22Z",
    "custom_id": "string",
    "tags": null,
    "parking_lot": { … },
    "organization": { … },
    "customer_columns": null,
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "building": { … },
    "price_group": { … }
  }
]

Update 'Pricegrouponlyenabledfor'

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
price_groupobject(Pricegroup)required
price_group.​idstring(uuid)
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

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

organizationobject or null(Organization)
buildingobject or null(Building)

Additional Validation Information:

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

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

curl -i -X PATCH \
  'https://dev.api.pigello.io/measurements/sensors/pricegrouponlyenabledfor/{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 '{
    "outdoor_area": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "custom_id": "string",
    "parking_lot": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "building": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "price_group": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    }
  }'

Responses

Successful update

Bodyapplication/json
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

price_groupobject(Pricegroup)required
price_group.​idstring(uuid)
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

created_atstring(date-time)read-only
custom_idstring or null<= 128 characters
tagsanyread-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

organizationobject or null(Organization)
customer_columnsanyread-only
buildingobject or null(Building)

Additional Validation Information:

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

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

Response
application/json
{
  "outdoor_area": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "custom_id": "string",
  "tags": null,
  "parking_lot": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "customer_columns": null,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "building": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "price_group": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  }
}
© Pigello. All rights reserved.