Skip to content

Update 'Commonarea'

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
usable_areanumber or null, (float)
categorystring or null, <= 64 characters

Additional Validation Information:

Enum Descriptions:

  • BAG - Bag

  • BAN - Ban

  • BBE - Bbe

  • BDE - Bde

  • BEA - Bea

  • BEC - Bec

  • BED - Bed

  • BEE - Bee

  • BGA - Bga

  • BGB - Bgb

  • BHA - Bha

  • BHB - Bhb

  • BZA - Bza

  • CAA - Caa

  • CAB - Cab

  • CAC - Cac

  • CAE - Cae

  • CAF - Caf

  • CAG - Cag

  • CBB - Cbb

  • CCA - Cca

  • CCB - Ccb

  • CCC - Ccc

  • DAA - Daa

  • DAC - Dac

  • DAF - Daf

  • DBA - Dba

  • DBC - Dbc

  • EAA - Eaa

  • EAC - Eac

  • EAD - Ead

  • EAE - Eae

  • EAF - Eaf

  • ABA - Aba

  • ABF - Abf

  • ABE - Abe

  • BBA - Bba

  • ABD - Abd

  • ACA - Aca

  • ABB - Abb

  • PX_LIBRARY - Px Library

  • PX_STORAGE - Px Storage

  • PX_COMMON - Px Common

  • PX_HOBBY - Px Hobby

  • PX_PLAYGROUND - Px Playground

  • PX_GARDEN - Px Garden

  • PX_LAUNDRY - Px Laundry

  • PX_OVERNIGHT_APARTMENT - Px Overnight Apartment

  • PX_LIVING_ROOM - Px Livingroom

  • PX_WORKROOM - Px Workroom

  • PX_STROLLER_ROOM - Px Stroller Room

  • PX_BICYCLE_ROOM - Px Bicycle Room

  • PX_RECREATION_ROOM - Px Recreation Room

  • PX_COARSE_LAUNDRY - Px Coarse Laundry

  • PX_HALLWAY - Px Hallway

  • PX_CLOAKING_ROOM - Px Cloaking Room

  • PX_BASEMENT_CORRIDOR - Px Basement Corridor

  • PX_OFFICE - Px Office

  • PX_FOOD_CELLAR - Px Food Cellar

  • PX_INDUSTRIAL_PREMISES - Px Industrial Premises

  • PX_DINING_ROOM - Px Dining Room

  • PX_FOOD_STORAGE_ROOM - Px Food Storage Room

  • PX_MOLDING_ROOM - Px Molding Room

  • PX_EXERCISE_ROOM - Px Exercise Room

  • PX_PENTRY - Px Pentry

  • PX_CLEANING_ROOM - Px Cleaning Room

  • PX_TECHNICAL_ROOM - Px Technical Room

  • PX_SUBSTATION - Px Substation

  • PX_ATTIC - Px Attic

  • PX_GARAGE - Px Garage

  • PX_OTHER - Px Other

Enum:"BAG""BAN""BBE""BDE""BEA""BEC""BED""BEE""BGA""BGB"
bi_areanumber or null, (float)
custom_idstring or null, <= 128 characters
landlord_custom_idstring or null, <= 255 characters
outdoor_areaobject or null(Outdoorarea)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: building

This field, or at least one of the following fields must be set: building

floorsArray of integers or null, (int32), unique
addressobject or null(Address)
tempered_areanumber or null, (float)
buildingobject or null(Building)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: outdoor_area

This field, or at least one of the following fields must be set: outdoor_area

archivedboolean
popular_namestring or null, <= 255 characters
organizationobject or null(Organization)
PATCH
/objects/spaces/spaces/commonarea/{pk}/
curl -i -X PATCH \
  'https://dev.api.pigello.io/objects/spaces/spaces/commonarea/{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 '{
    "usable_area": 0.1,
    "category": "BAG",
    "bi_area": 0.1,
    "custom_id": "string",
    "landlord_custom_id": "string",
    "outdoor_area": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "floors": [
      0
    ],
    "address": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "tempered_area": 0.1,
    "building": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "archived": true,
    "popular_name": "string",
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    }
  }'

Responses

Successful update

Bodyapplication/json
idstring, (uuid)read-onlyrequired

Additional Validation Information:

Must be unique

usable_areanumber or null, (float)
categorystring or null, <= 64 characters

Additional Validation Information:

Enum Descriptions:

  • BAG - Bag

  • BAN - Ban

  • BBE - Bbe

  • BDE - Bde

  • BEA - Bea

  • BEC - Bec

  • BED - Bed

  • BEE - Bee

  • BGA - Bga

  • BGB - Bgb

  • BHA - Bha

  • BHB - Bhb

  • BZA - Bza

  • CAA - Caa

  • CAB - Cab

  • CAC - Cac

  • CAE - Cae

  • CAF - Caf

  • CAG - Cag

  • CBB - Cbb

  • CCA - Cca

  • CCB - Ccb

  • CCC - Ccc

  • DAA - Daa

  • DAC - Dac

  • DAF - Daf

  • DBA - Dba

  • DBC - Dbc

  • EAA - Eaa

  • EAC - Eac

  • EAD - Ead

  • EAE - Eae

  • EAF - Eaf

  • ABA - Aba

  • ABF - Abf

  • ABE - Abe

  • BBA - Bba

  • ABD - Abd

  • ACA - Aca

  • ABB - Abb

  • PX_LIBRARY - Px Library

  • PX_STORAGE - Px Storage

  • PX_COMMON - Px Common

  • PX_HOBBY - Px Hobby

  • PX_PLAYGROUND - Px Playground

  • PX_GARDEN - Px Garden

  • PX_LAUNDRY - Px Laundry

  • PX_OVERNIGHT_APARTMENT - Px Overnight Apartment

  • PX_LIVING_ROOM - Px Livingroom

  • PX_WORKROOM - Px Workroom

  • PX_STROLLER_ROOM - Px Stroller Room

  • PX_BICYCLE_ROOM - Px Bicycle Room

  • PX_RECREATION_ROOM - Px Recreation Room

  • PX_COARSE_LAUNDRY - Px Coarse Laundry

  • PX_HALLWAY - Px Hallway

  • PX_CLOAKING_ROOM - Px Cloaking Room

  • PX_BASEMENT_CORRIDOR - Px Basement Corridor

  • PX_OFFICE - Px Office

  • PX_FOOD_CELLAR - Px Food Cellar

  • PX_INDUSTRIAL_PREMISES - Px Industrial Premises

  • PX_DINING_ROOM - Px Dining Room

  • PX_FOOD_STORAGE_ROOM - Px Food Storage Room

  • PX_MOLDING_ROOM - Px Molding Room

  • PX_EXERCISE_ROOM - Px Exercise Room

  • PX_PENTRY - Px Pentry

  • PX_CLEANING_ROOM - Px Cleaning Room

  • PX_TECHNICAL_ROOM - Px Technical Room

  • PX_SUBSTATION - Px Substation

  • PX_ATTIC - Px Attic

  • PX_GARAGE - Px Garage

  • PX_OTHER - Px Other

Enum:"BAG""BAN""BBE""BDE""BEA""BEC""BED""BEE""BGA""BGB"
bi_areanumber or null, (float)
created_atstring, (date-time)read-only
custom_idstring or null, <= 128 characters
landlord_custom_idstring or null, <= 255 characters
outdoor_areaobject or null(Outdoorarea)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: building

This field, or at least one of the following fields must be set: building

floorsArray of integers or null, (int32), unique
addressobject or null(Address)
tempered_areanumber or null, (float)
tagsanyread-only
buildingobject or null(Building)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: outdoor_area

This field, or at least one of the following fields must be set: outdoor_area

pending_monitor_approval_amountanyread-only
archivedboolean
customer_columnsanyread-only
popular_namestring or null, <= 255 characters
organizationobject or null(Organization)
Response
{
  "usable_area": 0.1,
  "category": "BAG",
  "bi_area": 0.1,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created_at": "2019-08-24T14:15:22Z",
  "custom_id": "string",
  "landlord_custom_id": "string",
  "outdoor_area": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "floors": [
    0
  ],
  "address": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "tempered_area": 0.1,
  "tags": null,
  "building": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "pending_monitor_approval_amount": null,
  "archived": true,
  "customer_columns": null,
  "popular_name": "string",
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  }
}
© Pigello. All rights reserved.