Skip to content
/
Create 'Inspectionerrands...

Errands (2.0.0)

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

Generalerrandaction

Operations

Generalerranddefaultdescription

Operations

Generalerrandsubtype

Operations

Generalerrandgroup

Operations

Generalerrandtype

Operations

Generalerrandactionfile

Operations

Generalerrandfile

Operations

Componentconditionvalue

Operations

Componentconditionnotation

Operations

Errandactiondefault

Operations

Inspectionerrandfault

Operations

Inspectionerrandsetting

Operations

Delete 'Inspectionerrandsetting'

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/errands/inspections/configurations/inspectionerrandsetting/{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

Create 'Inspectionerrandsetting'

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
is_activebooleanrequired
namestring<= 255 charactersrequired
id_number_separatorstring or null<= 1 characters
default_actionsArray of objects(Errandactiondefault)
industrial_premises_categoriesArray of strings or nullunique
delegation_purpose_plannerboolean
organizationobject or null(Organization)
parking_spot_categoriesArray of strings or nullunique
id_number_date_formatinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum0123
custom_idstring or null<= 128 characters
id_number_start_numberinteger or null(int32)[ 1 .. 2147483647 ]
auto_create_with_tenantsinteger or null(int32)[ -2147483648 .. 2147483647 ]

Additional Validation Information:

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

Enum012
protocols_should_be_signedboolean
brf_apartment_categoriesArray of strings or nullunique
protocol_settingobject or null(Inspectionerrandprotocolsetting)
id_number_prefixstring or null<= 32 characters
realestatesArray of objects(Realestate)
apartment_categoriesArray of strings or nullunique
auto_forward_delegation_after_daysinteger or null(int32)[ 1 .. 2147483647 ]
auto_create_on_cancellation_from_settingobject or null(Contractcancellationconfiguration)
should_be_invoicedboolean or null
id_number_min_id_lengthinteger or null(int32)[ 1 .. 10 ]
outdoor_section_categoriesArray of strings or nullunique
check_rooms_and_componentsboolean
protocols_visible_for_customersboolean
curl -i -X POST \
  https://dev.api.pigello.io/errands/inspections/configurations/inspectionerrandsetting/ \
  -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 '{
    "id_number_separator": "s",
    "default_actions": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      }
    ],
    "industrial_premises_categories": [
      "string"
    ],
    "delegation_purpose_planner": true,
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "parking_spot_categories": [
      "string"
    ],
    "id_number_date_format": 0,
    "custom_id": "string",
    "id_number_start_number": 1,
    "is_active": true,
    "auto_create_with_tenants": 0,
    "protocols_should_be_signed": true,
    "brf_apartment_categories": [
      "string"
    ],
    "name": "string",
    "protocol_setting": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "id_number_prefix": "string",
    "realestates": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      }
    ],
    "apartment_categories": [
      "string"
    ],
    "auto_forward_delegation_after_days": 1,
    "auto_create_on_cancellation_from_setting": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "should_be_invoiced": true,
    "id_number_min_id_length": 1,
    "outdoor_section_categories": [
      "string"
    ],
    "check_rooms_and_components": true,
    "protocols_visible_for_customers": true
  }'

Responses

Successful creation

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

Additional Validation Information:

Must be unique

id_number_separatorstring or null<= 1 characters
default_actionsArray of objects(Errandactiondefault)
industrial_premises_categoriesArray of strings or nullunique
delegation_purpose_plannerboolean
organizationobject or null(Organization)
parking_spot_categoriesArray of strings or nullunique
customer_columnsanyread-only
id_number_date_formatinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum0123
custom_idstring or null<= 128 characters
id_number_start_numberinteger or null(int32)[ 1 .. 2147483647 ]
auto_create_with_tenantsinteger or null(int32)[ -2147483648 .. 2147483647 ]

Additional Validation Information:

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

Enum012
protocols_should_be_signedboolean
brf_apartment_categoriesArray of strings or nullunique
protocol_settingobject or null(Inspectionerrandprotocolsetting)
id_number_prefixstring or null<= 32 characters
realestatesArray of objects(Realestate)
apartment_categoriesArray of strings or nullunique
auto_forward_delegation_after_daysinteger or null(int32)[ 1 .. 2147483647 ]
auto_create_on_cancellation_from_settingobject or null(Contractcancellationconfiguration)
should_be_invoicedboolean or null
id_number_min_id_lengthinteger or null(int32)[ 1 .. 10 ]
outdoor_section_categoriesArray of strings or nullunique
check_rooms_and_componentsboolean
tagsanyread-only
created_atstring(date-time)read-only
protocols_visible_for_customersboolean
pending_monitor_approval_amountanyread-only
Response
application/json
{
  "id_number_separator": "s",
  "default_actions": [
    { … }
  ],
  "industrial_premises_categories": [
    "string"
  ],
  "delegation_purpose_planner": true,
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "parking_spot_categories": [
    "string"
  ],
  "customer_columns": null,
  "id_number_date_format": 0,
  "custom_id": "string",
  "id_number_start_number": 1,
  "is_active": true,
  "auto_create_with_tenants": 0,
  "protocols_should_be_signed": true,
  "brf_apartment_categories": [
    "string"
  ],
  "name": "string",
  "protocol_setting": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "id_number_prefix": "string",
  "realestates": [
    { … }
  ],
  "apartment_categories": [
    "string"
  ],
  "auto_forward_delegation_after_days": 1,
  "auto_create_on_cancellation_from_setting": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "should_be_invoiced": true,
  "id_number_min_id_length": 1,
  "outdoor_section_categories": [
    "string"
  ],
  "check_rooms_and_components": true,
  "tags": null,
  "created_at": "2019-08-24T14:15:22Z",
  "protocols_visible_for_customers": true,
  "pending_monitor_approval_amount": null
}

List 'Inspectionerrandsetting'

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
apartment_categoriesany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: contains, Supports negation (via !): True

Operator: empty, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

auto_create_on_cancellation_from_settingany

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

auto_create_with_tenantsany

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

auto_forward_delegation_after_daysany

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

brf_apartment_categoriesany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: contains, Supports negation (via !): True

Operator: empty, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

check_rooms_and_componentsany

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

default_actionsany

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

delegation_purpose_plannerany

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

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

id_number_date_formatany

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

id_number_min_id_lengthany

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

id_number_prefixany

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

id_number_separatorany

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

id_number_start_numberany

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

industrial_premises_categoriesany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: contains, Supports negation (via !): True

Operator: empty, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

is_activeany

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

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_section_categoriesany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: contains, Supports negation (via !): True

Operator: empty, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

parking_spot_categoriesany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: contains, Supports negation (via !): True

Operator: empty, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

protocol_settingany

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

protocols_should_be_signedany

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

protocols_visible_for_customersany

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

realestatesany

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

should_be_invoicedany

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/errands/inspections/configurations/inspectionerrandsetting/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 [
is_activebooleanrequired
namestring<= 255 charactersrequired
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

id_number_separatorstring or null<= 1 characters
default_actionsArray of objects(Errandactiondefault)
industrial_premises_categoriesArray of strings or nullunique
delegation_purpose_plannerboolean
organizationobject or null(Organization)
parking_spot_categoriesArray of strings or nullunique
customer_columnsanyread-only
id_number_date_formatinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum0123
custom_idstring or null<= 128 characters
id_number_start_numberinteger or null(int32)[ 1 .. 2147483647 ]
auto_create_with_tenantsinteger or null(int32)[ -2147483648 .. 2147483647 ]

Additional Validation Information:

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

Enum012
protocols_should_be_signedboolean
brf_apartment_categoriesArray of strings or nullunique
protocol_settingobject or null(Inspectionerrandprotocolsetting)
id_number_prefixstring or null<= 32 characters
realestatesArray of objects(Realestate)
apartment_categoriesArray of strings or nullunique
auto_forward_delegation_after_daysinteger or null(int32)[ 1 .. 2147483647 ]
auto_create_on_cancellation_from_settingobject or null(Contractcancellationconfiguration)
should_be_invoicedboolean or null
id_number_min_id_lengthinteger or null(int32)[ 1 .. 10 ]
outdoor_section_categoriesArray of strings or nullunique
check_rooms_and_componentsboolean
tagsanyread-only
created_atstring(date-time)read-only
protocols_visible_for_customersboolean
pending_monitor_approval_amountanyread-only
]
Response
application/json
[
  {
    "id_number_separator": "s",
    "default_actions": [ … ],
    "industrial_premises_categories": [ … ],
    "delegation_purpose_planner": true,
    "organization": { … },
    "parking_spot_categories": [ … ],
    "customer_columns": null,
    "id_number_date_format": 0,
    "custom_id": "string",
    "id_number_start_number": 1,
    "is_active": true,
    "auto_create_with_tenants": 0,
    "protocols_should_be_signed": true,
    "brf_apartment_categories": [ … ],
    "name": "string",
    "protocol_setting": { … },
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "id_number_prefix": "string",
    "realestates": [ … ],
    "apartment_categories": [ … ],
    "auto_forward_delegation_after_days": 1,
    "auto_create_on_cancellation_from_setting": { … },
    "should_be_invoiced": true,
    "id_number_min_id_length": 1,
    "outdoor_section_categories": [ … ],
    "check_rooms_and_components": true,
    "tags": null,
    "created_at": "2019-08-24T14:15:22Z",
    "protocols_visible_for_customers": true,
    "pending_monitor_approval_amount": null
  }
]

Inspectionerrand

Operations

Inspectionerrandchecklist

Operations

Inspectionerrandfile

Operations

Inspectionerrandprotocolsetting

Operations

Inspectionerrandnote

Operations

Tenantinspectionassociation

Operations

Customerrandfieldvalue

Operations

Customerrandfieldinclusion

Operations

Customerrandfieldtype

Operations

Externalsupplier

Operations

Erranddelegationoffer

Operations

Erranddelegationinstruction

Operations

Errandcost

Operations
© Pigello. All rights reserved.