Skip to content
/
Create 'Inspectionerrand'

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

Create 'Inspectionerrand'

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
statusinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum012345
titlestring<= 255 charactersrequired
invoicing_statusinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum012345
disable_auto_delegationboolean
organizationobject or null(Organization)
requested_atstring or null(date-time)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: actual_done_time, planned_start_time

actual_done_timestring or null(date-time)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: requested_at

industrial_premisesobject or null(Industrialpremises)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment, parking_spot, common_area, brf_apartment

This field, or at least one of the following fields must be set: apartment, parking_spot, common_area, brf_apartment

parking_spotobject or null(Parkingspot)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: industrial_premises, apartment, common_area, brf_apartment

This field, or at least one of the following fields must be set: industrial_premises, apartment, common_area, brf_apartment

brf_apartmentobject or null(Brfapartment)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: industrial_premises, apartment, parking_spot, common_area

This field, or at least one of the following fields must be set: industrial_premises, apartment, parking_spot, common_area

planned_done_timestring or null(date-time)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: planned_start_time

common_areaobject or null(Commonarea)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: industrial_premises, apartment, parking_spot, brf_apartment

This field, or at least one of the following fields must be set: industrial_premises, apartment, parking_spot, brf_apartment

spent_minutesinteger or null(int32)[ 1 .. 2147483647 ]
apartmentobject or null(Apartment)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: industrial_premises, parking_spot, common_area, brf_apartment

This field, or at least one of the following fields must be set: industrial_premises, parking_spot, common_area, brf_apartment

outdoor_sectionobject or null(Outdoorsection)
settingobject or null(Inspectionerrandsetting)
id_numberstring or null
planned_start_timestring or null(date-time)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: requested_at, planned_done_time

protocol_signed_timestring or null(date-time)

Additional Validation Information:

This value requires that the following fields are also set: protocol_file

compared_toobject or null(Inspectionerrand)
created_byobject or null(Organizationuser)
custom_idstring or null<= 128 characters
curl -i -X POST \
  https://dev.api.pigello.io/errands/inspections/reporting/inspectionerrand/ \
  -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 '{
    "status": 0,
    "invoicing_status": 0,
    "disable_auto_delegation": true,
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "requested_at": "2019-08-24T14:15:22Z",
    "actual_done_time": "2019-08-24T14:15:22Z",
    "industrial_premises": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "parking_spot": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "brf_apartment": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "planned_done_time": "2019-08-24T14:15:22Z",
    "common_area": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "spent_minutes": 1,
    "apartment": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "outdoor_section": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "setting": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "id_number": "string",
    "planned_start_time": "2019-08-24T14:15:22Z",
    "protocol_signed_time": "2019-08-24T14:15:22Z",
    "compared_to": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "created_by": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "custom_id": "string",
    "title": "string"
  }'

Responses

Successful creation

Bodyapplication/json
statusinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum012345
validity_statusinteger(int32)[ -2147483648 .. 2147483647 ]read-onlyrequired
Enum01
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

titlestring<= 255 charactersrequired
pending_monitor_approval_amountanyread-only
id_number_orderinteger or null(int32)[ -2147483648 .. 2147483647 ]read-only
invoicing_statusinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum012345
disable_auto_delegationboolean
tagsanyread-only
organizationobject or null(Organization)
requested_atstring or null(date-time)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: actual_done_time, planned_start_time

actual_done_timestring or null(date-time)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: requested_at

industrial_premisesobject or null(Industrialpremises)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment, parking_spot, common_area, brf_apartment

This field, or at least one of the following fields must be set: apartment, parking_spot, common_area, brf_apartment

customer_columnsanyread-only
parking_spotobject or null(Parkingspot)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: industrial_premises, apartment, common_area, brf_apartment

This field, or at least one of the following fields must be set: industrial_premises, apartment, common_area, brf_apartment

brf_apartmentobject or null(Brfapartment)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: industrial_premises, apartment, parking_spot, common_area

This field, or at least one of the following fields must be set: industrial_premises, apartment, parking_spot, common_area

planned_done_timestring or null(date-time)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: planned_start_time

common_areaobject or null(Commonarea)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: industrial_premises, apartment, parking_spot, brf_apartment

This field, or at least one of the following fields must be set: industrial_premises, apartment, parking_spot, brf_apartment

spent_minutesinteger or null(int32)[ 1 .. 2147483647 ]
apartmentobject or null(Apartment)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: industrial_premises, parking_spot, common_area, brf_apartment

This field, or at least one of the following fields must be set: industrial_premises, parking_spot, common_area, brf_apartment

outdoor_sectionobject or null(Outdoorsection)
settingobject or null(Inspectionerrandsetting)
id_numberstring or null
planned_start_timestring or null(date-time)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: requested_at, planned_done_time

protocol_fileobject or nullread-only
protocol_signed_timestring or null(date-time)

Additional Validation Information:

This value requires that the following fields are also set: protocol_file

created_atstring(date-time)read-only
compared_toobject or null(Inspectionerrand)
created_byobject or null(Organizationuser)
custom_idstring or null<= 128 characters
Response
application/json
{
  "pending_monitor_approval_amount": null,
  "status": 0,
  "id_number_order": -2147483648,
  "invoicing_status": 0,
  "disable_auto_delegation": true,
  "tags": null,
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "requested_at": "2019-08-24T14:15:22Z",
  "actual_done_time": "2019-08-24T14:15:22Z",
  "validity_status": 0,
  "industrial_premises": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "customer_columns": null,
  "parking_spot": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "brf_apartment": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "planned_done_time": "2019-08-24T14:15:22Z",
  "common_area": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "spent_minutes": 1,
  "apartment": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "outdoor_section": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "setting": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "id_number": "string",
  "planned_start_time": "2019-08-24T14:15:22Z",
  "protocol_file": {
    "name": "string",
    "md5_hash": "string",
    "get": "string",
    "post": { … }
  },
  "protocol_signed_time": "2019-08-24T14:15:22Z",
  "created_at": "2019-08-24T14:15:22Z",
  "compared_to": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "created_by": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "custom_id": "string",
  "title": "string"
}

Update 'Inspectionerrand'

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
statusinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum012345
titlestring<= 255 charactersrequired
invoicing_statusinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum012345
disable_auto_delegationboolean
organizationobject or null(Organization)
requested_atstring or null(date-time)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: actual_done_time, planned_start_time

actual_done_timestring or null(date-time)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: requested_at

industrial_premisesobject or null(Industrialpremises)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment, parking_spot, common_area, brf_apartment

This field, or at least one of the following fields must be set: apartment, parking_spot, common_area, brf_apartment

parking_spotobject or null(Parkingspot)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: industrial_premises, apartment, common_area, brf_apartment

This field, or at least one of the following fields must be set: industrial_premises, apartment, common_area, brf_apartment

brf_apartmentobject or null(Brfapartment)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: industrial_premises, apartment, parking_spot, common_area

This field, or at least one of the following fields must be set: industrial_premises, apartment, parking_spot, common_area

planned_done_timestring or null(date-time)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: planned_start_time

common_areaobject or null(Commonarea)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: industrial_premises, apartment, parking_spot, brf_apartment

This field, or at least one of the following fields must be set: industrial_premises, apartment, parking_spot, brf_apartment

spent_minutesinteger or null(int32)[ 1 .. 2147483647 ]
apartmentobject or null(Apartment)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: industrial_premises, parking_spot, common_area, brf_apartment

This field, or at least one of the following fields must be set: industrial_premises, parking_spot, common_area, brf_apartment

outdoor_sectionobject or null(Outdoorsection)
settingobject or null(Inspectionerrandsetting)
id_numberstring or null
planned_start_timestring or null(date-time)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: requested_at, planned_done_time

protocol_signed_timestring or null(date-time)

Additional Validation Information:

This value requires that the following fields are also set: protocol_file

compared_toobject or null(Inspectionerrand)
created_byobject or null(Organizationuser)
custom_idstring or null<= 128 characters
curl -i -X PATCH \
  'https://dev.api.pigello.io/errands/inspections/reporting/inspectionerrand/{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 '{
    "status": 0,
    "invoicing_status": 0,
    "disable_auto_delegation": true,
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "requested_at": "2019-08-24T14:15:22Z",
    "actual_done_time": "2019-08-24T14:15:22Z",
    "industrial_premises": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "parking_spot": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "brf_apartment": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "planned_done_time": "2019-08-24T14:15:22Z",
    "common_area": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "spent_minutes": 1,
    "apartment": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "outdoor_section": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "setting": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "id_number": "string",
    "planned_start_time": "2019-08-24T14:15:22Z",
    "protocol_signed_time": "2019-08-24T14:15:22Z",
    "compared_to": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "created_by": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "custom_id": "string",
    "title": "string"
  }'

Responses

Successful update

Bodyapplication/json
statusinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum012345
validity_statusinteger(int32)[ -2147483648 .. 2147483647 ]read-onlyrequired
Enum01
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

titlestring<= 255 charactersrequired
pending_monitor_approval_amountanyread-only
id_number_orderinteger or null(int32)[ -2147483648 .. 2147483647 ]read-only
invoicing_statusinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum012345
disable_auto_delegationboolean
tagsanyread-only
organizationobject or null(Organization)
requested_atstring or null(date-time)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: actual_done_time, planned_start_time

actual_done_timestring or null(date-time)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: requested_at

industrial_premisesobject or null(Industrialpremises)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment, parking_spot, common_area, brf_apartment

This field, or at least one of the following fields must be set: apartment, parking_spot, common_area, brf_apartment

customer_columnsanyread-only
parking_spotobject or null(Parkingspot)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: industrial_premises, apartment, common_area, brf_apartment

This field, or at least one of the following fields must be set: industrial_premises, apartment, common_area, brf_apartment

brf_apartmentobject or null(Brfapartment)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: industrial_premises, apartment, parking_spot, common_area

This field, or at least one of the following fields must be set: industrial_premises, apartment, parking_spot, common_area

planned_done_timestring or null(date-time)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: planned_start_time

common_areaobject or null(Commonarea)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: industrial_premises, apartment, parking_spot, brf_apartment

This field, or at least one of the following fields must be set: industrial_premises, apartment, parking_spot, brf_apartment

spent_minutesinteger or null(int32)[ 1 .. 2147483647 ]
apartmentobject or null(Apartment)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: industrial_premises, parking_spot, common_area, brf_apartment

This field, or at least one of the following fields must be set: industrial_premises, parking_spot, common_area, brf_apartment

outdoor_sectionobject or null(Outdoorsection)
settingobject or null(Inspectionerrandsetting)
id_numberstring or null
planned_start_timestring or null(date-time)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: requested_at, planned_done_time

protocol_fileobject or nullread-only
protocol_signed_timestring or null(date-time)

Additional Validation Information:

This value requires that the following fields are also set: protocol_file

created_atstring(date-time)read-only
compared_toobject or null(Inspectionerrand)
created_byobject or null(Organizationuser)
custom_idstring or null<= 128 characters
Response
application/json
{
  "pending_monitor_approval_amount": null,
  "status": 0,
  "id_number_order": -2147483648,
  "invoicing_status": 0,
  "disable_auto_delegation": true,
  "tags": null,
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "requested_at": "2019-08-24T14:15:22Z",
  "actual_done_time": "2019-08-24T14:15:22Z",
  "validity_status": 0,
  "industrial_premises": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "customer_columns": null,
  "parking_spot": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "brf_apartment": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "planned_done_time": "2019-08-24T14:15:22Z",
  "common_area": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "spent_minutes": 1,
  "apartment": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "outdoor_section": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "setting": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "id_number": "string",
  "planned_start_time": "2019-08-24T14:15:22Z",
  "protocol_file": {
    "name": "string",
    "md5_hash": "string",
    "get": "string",
    "post": { … }
  },
  "protocol_signed_time": "2019-08-24T14:15:22Z",
  "created_at": "2019-08-24T14:15:22Z",
  "compared_to": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "created_by": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "custom_id": "string",
  "title": "string"
}

Delete 'Inspectionerrand'

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/inspections/reporting/inspectionerrand/{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

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.