Skip to content
/
Create 'Inspectionerrandc...

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

Inspectionerrand

Operations

Inspectionerrandchecklist

Operations

Update 'Inspectionerrandchecklist'

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
orderinteger(int32)[ -2147483648 .. 2147483647 ]required
namestring<= 255 charactersrequired
settingobject(Inspectionerrandsetting)required
setting.​idstring(uuid)
is_activeboolean
custom_idstring or null<= 128 characters
organizationobject or null(Organization)
curl -i -X PATCH \
  'https://dev.api.pigello.io/errands/inspections/configurations/inspectionerrandchecklist/{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 '{
    "order": -2147483648,
    "is_active": true,
    "name": "string",
    "setting": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "custom_id": "string",
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    }
  }'

Responses

Successful update

Bodyapplication/json
orderinteger(int32)[ -2147483648 .. 2147483647 ]required
namestring<= 255 charactersrequired
settingobject(Inspectionerrandsetting)required
setting.​idstring(uuid)
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

is_activeboolean
created_atstring(date-time)read-only
custom_idstring or null<= 128 characters
organizationobject or null(Organization)
Response
application/json
{
  "order": -2147483648,
  "is_active": true,
  "created_at": "2019-08-24T14:15:22Z",
  "name": "string",
  "setting": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "custom_id": "string",
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Create 'Inspectionerrandchecklist'

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
orderinteger(int32)[ -2147483648 .. 2147483647 ]required
namestring<= 255 charactersrequired
settingobject(Inspectionerrandsetting)required
setting.​idstring(uuid)
is_activeboolean
custom_idstring or null<= 128 characters
organizationobject or null(Organization)
curl -i -X POST \
  https://dev.api.pigello.io/errands/inspections/configurations/inspectionerrandchecklist/ \
  -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 '{
    "order": -2147483648,
    "is_active": true,
    "name": "string",
    "setting": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "custom_id": "string",
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    }
  }'

Responses

Successful creation

Bodyapplication/json
orderinteger(int32)[ -2147483648 .. 2147483647 ]required
namestring<= 255 charactersrequired
settingobject(Inspectionerrandsetting)required
setting.​idstring(uuid)
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

is_activeboolean
created_atstring(date-time)read-only
custom_idstring or null<= 128 characters
organizationobject or null(Organization)
Response
application/json
{
  "order": -2147483648,
  "is_active": true,
  "created_at": "2019-08-24T14:15:22Z",
  "name": "string",
  "setting": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "custom_id": "string",
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

List 'Inspectionerrandchecklist'

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
global_realestatesArray of objects
global_segmentsArray of objects
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

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

orderany

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

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

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

curl -i -X GET \
  'https://dev.api.pigello.io/errands/inspections/configurations/inspectionerrandchecklist/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 [
orderinteger(int32)[ -2147483648 .. 2147483647 ]required
namestring<= 255 charactersrequired
settingobject(Inspectionerrandsetting)required
setting.​idstring(uuid)
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

is_activeboolean
created_atstring(date-time)read-only
custom_idstring or null<= 128 characters
organizationobject or null(Organization)
]
Response
application/json
[
  {
    "order": -2147483648,
    "is_active": true,
    "created_at": "2019-08-24T14:15:22Z",
    "name": "string",
    "setting": { … },
    "custom_id": "string",
    "organization": { … },
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  }
]

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.