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

List 'Anonymousgeneralerrandlink'

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
auto_createdany

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

emailany

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

errandany

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

external_supplierany

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

link_typeany

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

organization_userany

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

phone_numberany

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

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

errandobject(Generalerrand)required
errand.​idstring(uuid)
link_typeinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum012
auto_createdbooleanread-only
organizationobject or null(Organization)
emailstring or null(email)<= 254 characters

Additional Validation Information:

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

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

created_atstring(date-time)read-only
organization_userobject or null(Organizationuser)

Additional Validation Information:

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

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

custom_idstring or null<= 128 characters
phone_numberstring or null<= 36 characters'^\+?1?\d{7,15}$'

Additional Validation Information:

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

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

external_supplierobject or null(Externalsupplier)

Additional Validation Information:

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

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

]
Response
application/json
[
  {
    "auto_created": true,
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "organization": { … },
    "errand": { … },
    "link_type": 0,
    "email": "user@example.com",
    "created_at": "2019-08-24T14:15:22Z",
    "organization_user": { … },
    "custom_id": "string",
    "phone_number": "string",
    "external_supplier": { … }
  }
]

Bulk write 'Anonymousgeneralerrandlink'

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 [
errandobject(Generalerrand)required
errand.​idstring(uuid)
link_typeinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum012
organizationobject or null(Organization)
emailstring or null(email)<= 254 characters

Additional Validation Information:

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

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

organization_userobject or null(Organizationuser)

Additional Validation Information:

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

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

custom_idstring or null<= 128 characters
phone_numberstring or null<= 36 characters'^\+?1?\d{7,15}$'

Additional Validation Information:

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

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

external_supplierobject or null(Externalsupplier)

Additional Validation Information:

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

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

]
curl -i -X POST \
  https://dev.api.pigello.io/errands/generalerrands/reporting/anonymousgeneralerrandlink/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 '[
    {
      "organization": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "errand": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "link_type": 0,
      "email": "user@example.com",
      "organization_user": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "custom_id": "string",
      "phone_number": "string",
      "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

errandobject(Generalerrand)required
errand.​idstring(uuid)
link_typeinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum012
auto_createdbooleanread-only
organizationobject or null(Organization)
emailstring or null(email)<= 254 characters

Additional Validation Information:

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

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

created_atstring(date-time)read-only
organization_userobject or null(Organizationuser)

Additional Validation Information:

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

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

custom_idstring or null<= 128 characters
phone_numberstring or null<= 36 characters'^\+?1?\d{7,15}$'

Additional Validation Information:

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

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

external_supplierobject or null(Externalsupplier)

Additional Validation Information:

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

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

]
Response
application/json
[
  {
    "auto_created": true,
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "organization": { … },
    "errand": { … },
    "link_type": 0,
    "email": "user@example.com",
    "created_at": "2019-08-24T14:15:22Z",
    "organization_user": { … },
    "custom_id": "string",
    "phone_number": "string",
    "external_supplier": { … }
  }
]

Create 'Anonymousgeneralerrandlink'

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
errandobject(Generalerrand)required
errand.​idstring(uuid)
link_typeinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum012
organizationobject or null(Organization)
emailstring or null(email)<= 254 characters

Additional Validation Information:

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

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

organization_userobject or null(Organizationuser)

Additional Validation Information:

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

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

custom_idstring or null<= 128 characters
phone_numberstring or null<= 36 characters'^\+?1?\d{7,15}$'

Additional Validation Information:

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

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

external_supplierobject or null(Externalsupplier)

Additional Validation Information:

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

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

curl -i -X POST \
  https://dev.api.pigello.io/errands/generalerrands/reporting/anonymousgeneralerrandlink/ \
  -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 '{
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "errand": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "link_type": 0,
    "email": "user@example.com",
    "organization_user": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "custom_id": "string",
    "phone_number": "string",
    "external_supplier": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    }
  }'

Responses

Successful creation

Bodyapplication/json
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

errandobject(Generalerrand)required
errand.​idstring(uuid)
link_typeinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum012
auto_createdbooleanread-only
organizationobject or null(Organization)
emailstring or null(email)<= 254 characters

Additional Validation Information:

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

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

created_atstring(date-time)read-only
organization_userobject or null(Organizationuser)

Additional Validation Information:

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

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

custom_idstring or null<= 128 characters
phone_numberstring or null<= 36 characters'^\+?1?\d{7,15}$'

Additional Validation Information:

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

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

external_supplierobject or null(Externalsupplier)

Additional Validation Information:

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

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

Response
application/json
{
  "auto_created": true,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "errand": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "link_type": 0,
  "email": "user@example.com",
  "created_at": "2019-08-24T14:15:22Z",
  "organization_user": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "custom_id": "string",
  "phone_number": "string",
  "external_supplier": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  }
}

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

Errandcost

Operations
© Pigello. All rights reserved.