Skip to content

Errands (2.0.0)

The 'Errands' application of the Core API

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

Customerrandfieldtype

Operations

Externalsupplier

Operations

Erranddelegationoffer

Operations

Erranddelegationinstruction

Operations

Bulk write 'Erranddelegationinstruction'

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 [
groupinteger(int32)[ -2147483648 .. 2147483647 ]required
inspection_errand_settingobject or null(Inspectionerrandsetting)

Additional Validation Information:

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

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

custom_idstring or null<= 128 characters
work_engagementobject or null(Workengagement)

Additional Validation Information:

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

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

general_errand_sub_typeobject or null(Generalerrandsubtype)

Additional Validation Information:

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

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

organizationobject or null(Organization)
general_errand_typeobject or null(Generalerrandtype)

Additional Validation Information:

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

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

organization_userobject or null(Organizationuser)

Additional Validation Information:

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

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

external_supplierobject or null(Externalsupplier)

Additional Validation Information:

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

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

]
curl -i -X POST \
  https://dev.api.pigello.io/errands/delegations/erranddelegationinstruction/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 '[
    {
      "inspection_errand_setting": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "custom_id": "string",
      "work_engagement": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "group": -2147483648,
      "general_errand_sub_type": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "organization": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "general_errand_type": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "organization_user": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "external_supplier": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      }
    }
  ]'

Responses

Successful bulk create/update

Bodyapplication/jsonArray [
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

groupinteger(int32)[ -2147483648 .. 2147483647 ]required
inspection_errand_settingobject or null(Inspectionerrandsetting)

Additional Validation Information:

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

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

custom_idstring or null<= 128 characters
work_engagementobject or null(Workengagement)

Additional Validation Information:

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

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

created_atstring(date-time)read-only
general_errand_sub_typeobject or null(Generalerrandsubtype)

Additional Validation Information:

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

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

organizationobject or null(Organization)
general_errand_typeobject or null(Generalerrandtype)

Additional Validation Information:

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

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

organization_userobject or null(Organizationuser)

Additional Validation Information:

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

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

external_supplierobject or null(Externalsupplier)

Additional Validation Information:

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

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

]
Response
application/json
[ { "inspection_errand_setting": {}, "custom_id": "string", "work_engagement": {}, "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "group": -2147483648, "created_at": "2019-08-24T14:15:22Z", "general_errand_sub_type": {}, "organization": {}, "general_errand_type": {}, "organization_user": {}, "external_supplier": {} } ]

Create 'Erranddelegationinstruction'

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
groupinteger(int32)[ -2147483648 .. 2147483647 ]required
inspection_errand_settingobject or null(Inspectionerrandsetting)

Additional Validation Information:

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

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

custom_idstring or null<= 128 characters
work_engagementobject or null(Workengagement)

Additional Validation Information:

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

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

general_errand_sub_typeobject or null(Generalerrandsubtype)

Additional Validation Information:

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

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

organizationobject or null(Organization)
general_errand_typeobject or null(Generalerrandtype)

Additional Validation Information:

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

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

organization_userobject or null(Organizationuser)

Additional Validation Information:

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

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

external_supplierobject or null(Externalsupplier)

Additional Validation Information:

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

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

curl -i -X POST \
  https://dev.api.pigello.io/errands/delegations/erranddelegationinstruction/ \
  -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_setting": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "custom_id": "string",
    "work_engagement": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "group": -2147483648,
    "general_errand_sub_type": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "general_errand_type": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "organization_user": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "external_supplier": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    }
  }'

Responses

Successful creation

Bodyapplication/json
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

groupinteger(int32)[ -2147483648 .. 2147483647 ]required
inspection_errand_settingobject or null(Inspectionerrandsetting)

Additional Validation Information:

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

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

custom_idstring or null<= 128 characters
work_engagementobject or null(Workengagement)

Additional Validation Information:

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

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

created_atstring(date-time)read-only
general_errand_sub_typeobject or null(Generalerrandsubtype)

Additional Validation Information:

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

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

organizationobject or null(Organization)
general_errand_typeobject or null(Generalerrandtype)

Additional Validation Information:

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

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

organization_userobject or null(Organizationuser)

Additional Validation Information:

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

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

external_supplierobject or null(Externalsupplier)

Additional Validation Information:

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

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

Response
application/json
{ "inspection_errand_setting": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" }, "custom_id": "string", "work_engagement": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" }, "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "group": -2147483648, "created_at": "2019-08-24T14:15:22Z", "general_errand_sub_type": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" }, "organization": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" }, "general_errand_type": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" }, "organization_user": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" }, "external_supplier": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" } }

Errandcost

Operations