Skip to content

Configurations (2.0.0)

The 'Configurations' 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

Commonorganizationsettings

Operations

Validationconfiguration

Operations

Get 'Validationconfiguration'

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

created_atstring(date-time)read-only
control_usable_area_against_structureboolean
require_contract_default_vatboolean
control_tempered_area_against_structureboolean
require_component_modelboolean
custom_idstring or null<= 128 characters
require_component_typeboolean
require_sni_for_corporate_customersboolean
custom_id_regexstring or null<= 255 characters
control_building_area_against_realestateboolean
control_bi_area_against_structureboolean
require_customer_custom_idboolean or null
contract_id_number_regexstring or null<= 255 characters
require_ssn_for_private_customersboolean
organizationobject or null(Organization)
Response
application/json
{
  "created_at": "2019-08-24T14:15:22Z",
  "control_usable_area_against_structure": true,
  "require_contract_default_vat": true,
  "control_tempered_area_against_structure": true,
  "require_component_model": true,
  "custom_id": "string",
  "require_component_type": true,
  "require_sni_for_corporate_customers": true,
  "custom_id_regex": "string",
  "control_building_area_against_realestate": true,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "control_bi_area_against_structure": true,
  "require_customer_custom_id": true,
  "contract_id_number_regex": "string",
  "require_ssn_for_private_customers": true,
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  }
}

Update 'Validationconfiguration'

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
control_usable_area_against_structureboolean
require_contract_default_vatboolean
control_tempered_area_against_structureboolean
require_component_modelboolean
custom_idstring or null<= 128 characters
require_component_typeboolean
require_sni_for_corporate_customersboolean
custom_id_regexstring or null<= 255 characters
control_building_area_against_realestateboolean
control_bi_area_against_structureboolean
require_customer_custom_idboolean or null
contract_id_number_regexstring or null<= 255 characters
require_ssn_for_private_customersboolean
organizationobject or null(Organization)
curl -i -X PATCH \
  'https://dev.api.pigello.io/configurations/validationconfiguration/{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 '{
    "control_usable_area_against_structure": true,
    "require_contract_default_vat": true,
    "control_tempered_area_against_structure": true,
    "require_component_model": true,
    "custom_id": "string",
    "require_component_type": true,
    "require_sni_for_corporate_customers": true,
    "custom_id_regex": "string",
    "control_building_area_against_realestate": true,
    "control_bi_area_against_structure": true,
    "require_customer_custom_id": true,
    "contract_id_number_regex": "string",
    "require_ssn_for_private_customers": true,
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    }
  }'

Responses

Successful update

Bodyapplication/json
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

created_atstring(date-time)read-only
control_usable_area_against_structureboolean
require_contract_default_vatboolean
control_tempered_area_against_structureboolean
require_component_modelboolean
custom_idstring or null<= 128 characters
require_component_typeboolean
require_sni_for_corporate_customersboolean
custom_id_regexstring or null<= 255 characters
control_building_area_against_realestateboolean
control_bi_area_against_structureboolean
require_customer_custom_idboolean or null
contract_id_number_regexstring or null<= 255 characters
require_ssn_for_private_customersboolean
organizationobject or null(Organization)
Response
application/json
{
  "created_at": "2019-08-24T14:15:22Z",
  "control_usable_area_against_structure": true,
  "require_contract_default_vat": true,
  "control_tempered_area_against_structure": true,
  "require_component_model": true,
  "custom_id": "string",
  "require_component_type": true,
  "require_sni_for_corporate_customers": true,
  "custom_id_regex": "string",
  "control_building_area_against_realestate": true,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "control_bi_area_against_structure": true,
  "require_customer_custom_id": true,
  "contract_id_number_regex": "string",
  "require_ssn_for_private_customers": true,
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  }
}

Create 'Validationconfiguration'

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
control_usable_area_against_structureboolean
require_contract_default_vatboolean
control_tempered_area_against_structureboolean
require_component_modelboolean
custom_idstring or null<= 128 characters
require_component_typeboolean
require_sni_for_corporate_customersboolean
custom_id_regexstring or null<= 255 characters
control_building_area_against_realestateboolean
control_bi_area_against_structureboolean
require_customer_custom_idboolean or null
contract_id_number_regexstring or null<= 255 characters
require_ssn_for_private_customersboolean
organizationobject or null(Organization)
curl -i -X POST \
  https://dev.api.pigello.io/configurations/validationconfiguration/ \
  -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 '{
    "control_usable_area_against_structure": true,
    "require_contract_default_vat": true,
    "control_tempered_area_against_structure": true,
    "require_component_model": true,
    "custom_id": "string",
    "require_component_type": true,
    "require_sni_for_corporate_customers": true,
    "custom_id_regex": "string",
    "control_building_area_against_realestate": true,
    "control_bi_area_against_structure": true,
    "require_customer_custom_id": true,
    "contract_id_number_regex": "string",
    "require_ssn_for_private_customers": true,
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    }
  }'

Responses

Successful creation

Bodyapplication/json
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

created_atstring(date-time)read-only
control_usable_area_against_structureboolean
require_contract_default_vatboolean
control_tempered_area_against_structureboolean
require_component_modelboolean
custom_idstring or null<= 128 characters
require_component_typeboolean
require_sni_for_corporate_customersboolean
custom_id_regexstring or null<= 255 characters
control_building_area_against_realestateboolean
control_bi_area_against_structureboolean
require_customer_custom_idboolean or null
contract_id_number_regexstring or null<= 255 characters
require_ssn_for_private_customersboolean
organizationobject or null(Organization)
Response
application/json
{
  "created_at": "2019-08-24T14:15:22Z",
  "control_usable_area_against_structure": true,
  "require_contract_default_vat": true,
  "control_tempered_area_against_structure": true,
  "require_component_model": true,
  "custom_id": "string",
  "require_component_type": true,
  "require_sni_for_corporate_customers": true,
  "custom_id_regex": "string",
  "control_building_area_against_realestate": true,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "control_bi_area_against_structure": true,
  "require_customer_custom_id": true,
  "contract_id_number_regex": "string",
  "require_ssn_for_private_customers": true,
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  }
}

Automationconfiguration

Operations

Customercommunicationconfiguration

Operations

Securityconfiguration

Operations

Retroactivityconfiguration

Operations
© Pigello. All rights reserved.