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

Create 'Sensorspecification'

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
unit_namestring<= 64 charactersrequired
billing_articleobject or null(Article)
custom_idstring or null<= 128 characters
organizationobject or null(Organization)
categoryinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum01234567
curl -i -X POST \
  https://dev.api.pigello.io/measurements/sensors/sensorspecification/ \
  -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 '{
    "billing_article": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "custom_id": "string",
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "name": "string",
    "unit_name": "string",
    "category": 0
  }'

Responses

Successful creation

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

Additional Validation Information:

Must be unique

unit_namestring<= 64 charactersrequired
billing_articleobject or null(Article)
customer_columnsanyread-only
custom_idstring or null<= 128 characters
organizationobject or null(Organization)
tagsanyread-only
created_atstring(date-time)read-only
categoryinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum01234567
Response
application/json
{
  "billing_article": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "customer_columns": null,
  "custom_id": "string",
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "name": "string",
  "tags": null,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "unit_name": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "category": 0
}

Get 'Sensorspecification'

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/measurements/sensors/sensorspecification/{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
namestring<= 255 charactersrequired
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

unit_namestring<= 64 charactersrequired
billing_articleobject or null(Article)
customer_columnsanyread-only
custom_idstring or null<= 128 characters
organizationobject or null(Organization)
tagsanyread-only
created_atstring(date-time)read-only
categoryinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum01234567
Response
application/json
{
  "billing_article": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "customer_columns": null,
  "custom_id": "string",
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "name": "string",
  "tags": null,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "unit_name": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "category": 0
}

Update 'Sensorspecification'

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
unit_namestring<= 64 charactersrequired
billing_articleobject or null(Article)
custom_idstring or null<= 128 characters
organizationobject or null(Organization)
categoryinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum01234567
curl -i -X PATCH \
  'https://dev.api.pigello.io/measurements/sensors/sensorspecification/{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 '{
    "billing_article": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "custom_id": "string",
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "name": "string",
    "unit_name": "string",
    "category": 0
  }'

Responses

Successful update

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

Additional Validation Information:

Must be unique

unit_namestring<= 64 charactersrequired
billing_articleobject or null(Article)
customer_columnsanyread-only
custom_idstring or null<= 128 characters
organizationobject or null(Organization)
tagsanyread-only
created_atstring(date-time)read-only
categoryinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum01234567
Response
application/json
{
  "billing_article": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "customer_columns": null,
  "custom_id": "string",
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "name": "string",
  "tags": null,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "unit_name": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "category": 0
}

Pricegrouponlyenabledfor

Operations
© Pigello. All rights reserved.