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

Inspectionerrandprotocolsetting

Operations

Inspectionerrandnote

Operations

Tenantinspectionassociation

Operations

Customerrandfieldvalue

Operations

Customerrandfieldinclusion

Operations

Update 'Customerrandfieldinclusion'

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
field_typeobject(Customerrandfieldtype)required
field_type.​idstring(uuid)
orderinteger(int32)[ -2147483648 .. 2147483647 ]required
inspection_errand_checklistobject or null(Inspectionerrandchecklist)

Additional Validation Information:

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

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

general_errand_typeobject or null(Generalerrandtype)

Additional Validation Information:

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

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

custom_idstring or null<= 128 characters
organizationobject or null(Organization)
curl -i -X PATCH \
  'https://dev.api.pigello.io/errands/customfields/customerrandfieldinclusion/{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 '{
    "inspection_errand_checklist": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "general_errand_type": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "custom_id": "string",
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "field_type": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "order": -2147483648
  }'

Responses

Successful update

Bodyapplication/json
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

field_typeobject(Customerrandfieldtype)required
field_type.​idstring(uuid)
orderinteger(int32)[ -2147483648 .. 2147483647 ]required
inspection_errand_checklistobject or null(Inspectionerrandchecklist)

Additional Validation Information:

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

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

general_errand_typeobject or null(Generalerrandtype)

Additional Validation Information:

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

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

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

Delete 'Customerrandfieldinclusion'

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/customfields/customerrandfieldinclusion/{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

Get 'Customerrandfieldinclusion'

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/customfields/customerrandfieldinclusion/{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

field_typeobject(Customerrandfieldtype)required
field_type.​idstring(uuid)
orderinteger(int32)[ -2147483648 .. 2147483647 ]required
inspection_errand_checklistobject or null(Inspectionerrandchecklist)

Additional Validation Information:

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

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

general_errand_typeobject or null(Generalerrandtype)

Additional Validation Information:

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

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

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

Customerrandfieldtype

Operations

Externalsupplier

Operations

Erranddelegationoffer

Operations

Erranddelegationinstruction

Operations

Errandcost

Operations
© Pigello. All rights reserved.