Skip to content

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

Inspectionerrandfile

Operations

Bulk write 'Inspectionerrandfile'

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 [
file_objobjectrequired
file_obj.​namestring

wanted filename of the file

file_obj.​md5_hashstring

base64 encoded md5hash of the file

file_obj.​getstring(url)
file_obj.​postobject
inspection_errand_noteobject or null(Inspectionerrandnote)

Additional Validation Information:

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

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

inspection_errand_faultobject or null(Inspectionerrandfault)

Additional Validation Information:

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

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

organizationobject or null(Organization)
custom_idstring or null<= 128 characters
]
curl -i -X POST \
  https://dev.api.pigello.io/errands/inspections/reporting/inspectionerrandfile/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 '[
    {
      "file_obj": {
        "name": "string",
        "md5_hash": "string",
        "get": "string",
        "post": {
          "url": "string",
          "fields": {}
        }
      },
      "inspection_errand_note": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "inspection_errand_fault": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "organization": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "custom_id": "string"
    }
  ]'

Responses

Successful bulk create/update

Bodyapplication/jsonArray [
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

file_objobjectrequired
file_obj.​namestring

wanted filename of the file

file_obj.​md5_hashstring

base64 encoded md5hash of the file

file_obj.​getstring(url)
file_obj.​postobject
inspection_errand_noteobject or null(Inspectionerrandnote)

Additional Validation Information:

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

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

inspection_errand_faultobject or null(Inspectionerrandfault)

Additional Validation Information:

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

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

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

List 'Inspectionerrandfile'

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

inspection_errand_faultany

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

inspection_errand_noteany

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

curl -i -X GET \
  'https://dev.api.pigello.io/errands/inspections/reporting/inspectionerrandfile/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

file_objobjectrequired
file_obj.​namestring

wanted filename of the file

file_obj.​md5_hashstring

base64 encoded md5hash of the file

file_obj.​getstring(url)
file_obj.​postobject
inspection_errand_noteobject or null(Inspectionerrandnote)

Additional Validation Information:

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

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

inspection_errand_faultobject or null(Inspectionerrandfault)

Additional Validation Information:

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

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

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

Get 'Inspectionerrandfile'

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/errands/inspections/reporting/inspectionerrandfile/{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
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

file_objobjectrequired
file_obj.​namestring

wanted filename of the file

file_obj.​md5_hashstring

base64 encoded md5hash of the file

file_obj.​getstring(url)
file_obj.​postobject
inspection_errand_noteobject or null(Inspectionerrandnote)

Additional Validation Information:

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

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

inspection_errand_faultobject or null(Inspectionerrandfault)

Additional Validation Information:

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

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

organizationobject or null(Organization)
created_atstring(date-time)read-only
custom_idstring or null<= 128 characters
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "file_obj": {
    "name": "string",
    "md5_hash": "string",
    "get": "string",
    "post": { … }
  },
  "inspection_errand_note": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "inspection_errand_fault": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "custom_id": "string"
}

Inspectionerrandprotocolsetting

Operations

Inspectionerrandnote

Operations

Tenantinspectionassociation

Operations

Customerrandfieldvalue

Operations

Customerrandfieldinclusion

Operations

Customerrandfieldtype

Operations

Externalsupplier

Operations

Erranddelegationoffer

Operations

Erranddelegationinstruction

Operations

Errandcost

Operations
© Pigello. All rights reserved.