Skip to content
/
Create 'Customerrandfield...

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

Inspectionerrandnote

Operations

Tenantinspectionassociation

Operations

Customerrandfieldvalue

Operations

Customerrandfieldinclusion

Operations

Customerrandfieldtype

Operations

Update 'Customerrandfieldtype'

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
titlestring<= 255 charactersrequired
kindinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum012345678
optionsArray of strings or nullunique
organizationobject or null(Organization)
custom_idstring or null<= 128 characters
descriptionstring or null<= 255 characters
requiredboolean
curl -i -X PATCH \
  'https://dev.api.pigello.io/errands/customfields/customerrandfieldtype/{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 '{
    "options": [
      "string"
    ],
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "custom_id": "string",
    "title": "string",
    "description": "string",
    "required": true,
    "kind": 0
  }'

Responses

Successful update

Bodyapplication/json
titlestring<= 255 charactersrequired
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

kindinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum012345678
optionsArray of strings or nullunique
organizationobject or null(Organization)
custom_idstring or null<= 128 characters
descriptionstring or null<= 255 characters
requiredboolean
created_atstring(date-time)read-only
Response
application/json
{
  "options": [
    "string"
  ],
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "custom_id": "string",
  "title": "string",
  "description": "string",
  "required": true,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created_at": "2019-08-24T14:15:22Z",
  "kind": 0
}

Create 'Customerrandfieldtype'

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
titlestring<= 255 charactersrequired
kindinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum012345678
optionsArray of strings or nullunique
organizationobject or null(Organization)
custom_idstring or null<= 128 characters
descriptionstring or null<= 255 characters
requiredboolean
curl -i -X POST \
  https://dev.api.pigello.io/errands/customfields/customerrandfieldtype/ \
  -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 '{
    "options": [
      "string"
    ],
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "custom_id": "string",
    "title": "string",
    "description": "string",
    "required": true,
    "kind": 0
  }'

Responses

Successful creation

Bodyapplication/json
titlestring<= 255 charactersrequired
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

kindinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum012345678
optionsArray of strings or nullunique
organizationobject or null(Organization)
custom_idstring or null<= 128 characters
descriptionstring or null<= 255 characters
requiredboolean
created_atstring(date-time)read-only
Response
application/json
{
  "options": [
    "string"
  ],
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "custom_id": "string",
  "title": "string",
  "description": "string",
  "required": true,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created_at": "2019-08-24T14:15:22Z",
  "kind": 0
}

Externalsupplier

Operations

Erranddelegationoffer

Operations

Erranddelegationinstruction

Operations

Errandcost

Operations
© Pigello. All rights reserved.