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

Update 'Inspectionerrandprotocolsetting'

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
show_performersbooleanrequired
namestring<= 255 charactersrequired
show_faultsbooleanrequired
show_faults_descriptionsbooleanrequired
show_tenant_associationsbooleanrequired
show_space_infobooleanrequired
show_notes_imagesbooleanrequired
show_checklistsbooleanrequired
show_nominal_componentsbooleanrequired
show_notesbooleanrequired
show_responsible_partiesbooleanrequired
show_faults_imagesbooleanrequired
show_faults_action_proposalsbooleanrequired
show_component_conditionsbooleanrequired
custom_idstring or null<= 128 characters
show_logoobject or null
organizationobject or null(Organization)
include_attachmentobject or null
curl -i -X PATCH \
  'https://dev.api.pigello.io/errands/inspections/configurations/inspectionerrandprotocolsetting/{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 '{
    "show_performers": true,
    "name": "string",
    "show_faults": true,
    "show_faults_descriptions": true,
    "custom_id": "string",
    "show_logo": {
      "name": "string",
      "md5_hash": "string",
      "get": "string",
      "post": {
        "url": "string",
        "fields": {}
      }
    },
    "show_tenant_associations": true,
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "include_attachment": {
      "name": "string",
      "md5_hash": "string",
      "get": "string",
      "post": {
        "url": "string",
        "fields": {}
      }
    },
    "show_space_info": true,
    "show_notes_images": true,
    "show_checklists": true,
    "show_nominal_components": true,
    "show_notes": true,
    "show_responsible_parties": true,
    "show_faults_images": true,
    "show_faults_action_proposals": true,
    "show_component_conditions": true
  }'

Responses

Successful update

Bodyapplication/json
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

show_performersbooleanrequired
namestring<= 255 charactersrequired
show_faultsbooleanrequired
show_faults_descriptionsbooleanrequired
show_tenant_associationsbooleanrequired
show_space_infobooleanrequired
show_notes_imagesbooleanrequired
show_checklistsbooleanrequired
show_nominal_componentsbooleanrequired
show_notesbooleanrequired
show_responsible_partiesbooleanrequired
show_faults_imagesbooleanrequired
show_faults_action_proposalsbooleanrequired
show_component_conditionsbooleanrequired
custom_idstring or null<= 128 characters
show_logoobject or null
organizationobject or null(Organization)
created_atstring(date-time)read-only
include_attachmentobject or null
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "show_performers": true,
  "name": "string",
  "show_faults": true,
  "show_faults_descriptions": true,
  "custom_id": "string",
  "show_logo": {
    "name": "string",
    "md5_hash": "string",
    "get": "string",
    "post": { … }
  },
  "show_tenant_associations": true,
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "include_attachment": {
    "name": "string",
    "md5_hash": "string",
    "get": "string",
    "post": { … }
  },
  "show_space_info": true,
  "show_notes_images": true,
  "show_checklists": true,
  "show_nominal_components": true,
  "show_notes": true,
  "show_responsible_parties": true,
  "show_faults_images": true,
  "show_faults_action_proposals": true,
  "show_component_conditions": true
}

Get 'Inspectionerrandprotocolsetting'

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/configurations/inspectionerrandprotocolsetting/{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

show_performersbooleanrequired
namestring<= 255 charactersrequired
show_faultsbooleanrequired
show_faults_descriptionsbooleanrequired
show_tenant_associationsbooleanrequired
show_space_infobooleanrequired
show_notes_imagesbooleanrequired
show_checklistsbooleanrequired
show_nominal_componentsbooleanrequired
show_notesbooleanrequired
show_responsible_partiesbooleanrequired
show_faults_imagesbooleanrequired
show_faults_action_proposalsbooleanrequired
show_component_conditionsbooleanrequired
custom_idstring or null<= 128 characters
show_logoobject or null
organizationobject or null(Organization)
created_atstring(date-time)read-only
include_attachmentobject or null
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "show_performers": true,
  "name": "string",
  "show_faults": true,
  "show_faults_descriptions": true,
  "custom_id": "string",
  "show_logo": {
    "name": "string",
    "md5_hash": "string",
    "get": "string",
    "post": { … }
  },
  "show_tenant_associations": true,
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "include_attachment": {
    "name": "string",
    "md5_hash": "string",
    "get": "string",
    "post": { … }
  },
  "show_space_info": true,
  "show_notes_images": true,
  "show_checklists": true,
  "show_nominal_components": true,
  "show_notes": true,
  "show_responsible_parties": true,
  "show_faults_images": true,
  "show_faults_action_proposals": true,
  "show_component_conditions": true
}

Delete 'Inspectionerrandprotocolsetting'

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/configurations/inspectionerrandprotocolsetting/{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

Inspectionerrandnote

Operations

Tenantinspectionassociation

Operations

Customerrandfieldvalue

Operations

Customerrandfieldinclusion

Operations

Customerrandfieldtype

Operations

Externalsupplier

Operations

Erranddelegationoffer

Operations

Erranddelegationinstruction

Operations

Errandcost

Operations
© Pigello. All rights reserved.