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

Create 'Pricegroup'

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
custom_idstring or null<= 128 characters
auto_acceptboolean
descriptionstring or null<= 512 characters
sensor_specificationobject or null(Sensorspecification)
target_price_change_day_of_monthinteger or null(int32)[ 1 .. 31 ]

Additional Validation Information:

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

periods_offsetinteger(int32)[ 1 .. 2147483647 ]
organizationobject or null(Organization)
target_price_change_interval_daysinteger or null(int32)[ 1 .. 2147483647 ]

Additional Validation Information:

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

curl -i -X POST \
  https://dev.api.pigello.io/measurements/sensors/pricegroup/ \
  -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 '{
    "custom_id": "string",
    "name": "string",
    "auto_accept": true,
    "description": "string",
    "sensor_specification": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "target_price_change_day_of_month": 1,
    "periods_offset": 1,
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "target_price_change_interval_days": 1
  }'

Responses

Successful creation

Bodyapplication/json
namestring<= 255 charactersrequired
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

custom_idstring or null<= 128 characters
tagsanyread-only
auto_acceptboolean
descriptionstring or null<= 512 characters
price_itemsanyread-only
created_atstring(date-time)read-only
customer_columnsanyread-only
sensor_specificationobject or null(Sensorspecification)
target_price_change_day_of_monthinteger or null(int32)[ 1 .. 31 ]

Additional Validation Information:

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

periods_offsetinteger(int32)[ 1 .. 2147483647 ]
organizationobject or null(Organization)
target_price_change_interval_daysinteger or null(int32)[ 1 .. 2147483647 ]

Additional Validation Information:

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

Response
application/json
{
  "custom_id": "string",
  "name": "string",
  "tags": null,
  "auto_accept": true,
  "description": "string",
  "price_items": null,
  "created_at": "2019-08-24T14:15:22Z",
  "customer_columns": null,
  "sensor_specification": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "target_price_change_day_of_month": 1,
  "periods_offset": 1,
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "target_price_change_interval_days": 1,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Delete 'Pricegroup'

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/measurements/sensors/pricegroup/{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 'Pricegroup'

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
custom_idstring or null<= 128 characters
auto_acceptboolean
descriptionstring or null<= 512 characters
sensor_specificationobject or null(Sensorspecification)
target_price_change_day_of_monthinteger or null(int32)[ 1 .. 31 ]

Additional Validation Information:

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

periods_offsetinteger(int32)[ 1 .. 2147483647 ]
organizationobject or null(Organization)
target_price_change_interval_daysinteger or null(int32)[ 1 .. 2147483647 ]

Additional Validation Information:

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

curl -i -X PATCH \
  'https://dev.api.pigello.io/measurements/sensors/pricegroup/{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 '{
    "custom_id": "string",
    "name": "string",
    "auto_accept": true,
    "description": "string",
    "sensor_specification": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "target_price_change_day_of_month": 1,
    "periods_offset": 1,
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "target_price_change_interval_days": 1
  }'

Responses

Successful update

Bodyapplication/json
namestring<= 255 charactersrequired
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

custom_idstring or null<= 128 characters
tagsanyread-only
auto_acceptboolean
descriptionstring or null<= 512 characters
price_itemsanyread-only
created_atstring(date-time)read-only
customer_columnsanyread-only
sensor_specificationobject or null(Sensorspecification)
target_price_change_day_of_monthinteger or null(int32)[ 1 .. 31 ]

Additional Validation Information:

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

periods_offsetinteger(int32)[ 1 .. 2147483647 ]
organizationobject or null(Organization)
target_price_change_interval_daysinteger or null(int32)[ 1 .. 2147483647 ]

Additional Validation Information:

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

Response
application/json
{
  "custom_id": "string",
  "name": "string",
  "tags": null,
  "auto_accept": true,
  "description": "string",
  "price_items": null,
  "created_at": "2019-08-24T14:15:22Z",
  "customer_columns": null,
  "sensor_specification": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "target_price_change_day_of_month": 1,
  "periods_offset": 1,
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "target_price_change_interval_days": 1,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Sensorspecification

Operations

Pricegrouponlyenabledfor

Operations
© Pigello. All rights reserved.