Skip to content
/
List 'Inspectionerrandpro...

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

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

List '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
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
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

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

nameany

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

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

show_checklistsany

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

show_component_conditionsany

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

show_faultsany

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

show_faults_action_proposalsany

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

show_faults_descriptionsany

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

show_faults_imagesany

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

show_nominal_componentsany

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

show_notesany

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

show_notes_imagesany

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

show_performersany

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

show_responsible_partiesany

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

show_space_infoany

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

show_tenant_associationsany

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

curl -i -X GET \
  'https://dev.api.pigello.io/errands/inspections/configurations/inspectionerrandprotocolsetting/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

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": { … },
    "show_tenant_associations": true,
    "organization": { … },
    "created_at": "2019-08-24T14:15:22Z",
    "include_attachment": { … },
    "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
  }
]

Bulk write '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
Bodyapplication/jsonArray [
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 POST \
  https://dev.api.pigello.io/errands/inspections/configurations/inspectionerrandprotocolsetting/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 '[
    {
      "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 bulk create/update

Bodyapplication/jsonArray [
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": { … },
    "show_tenant_associations": true,
    "organization": { … },
    "created_at": "2019-08-24T14:15:22Z",
    "include_attachment": { … },
    "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
  }
]

Inspectionerrandnote

Operations

Tenantinspectionassociation

Operations

Customerrandfieldvalue

Operations

Customerrandfieldinclusion

Operations

Customerrandfieldtype

Operations

Externalsupplier

Operations

Erranddelegationoffer

Operations

Erranddelegationinstruction

Operations

Errandcost

Operations
© Pigello. All rights reserved.