Skip to content

Create 'Spacerenovationnotation'

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
planned_end_datestring, (date)required

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: planned_start_date

namestring, <= 255 charactersrequired
planned_start_datestring, (date)required

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: planned_end_date

post_completion_addon_valuenumber or null, (float)

Additional Validation Information:

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

This value requires that the following fields are also set: article

custom_idstring or null, <= 128 characters
post_completion_addon_percentage_modeinteger or null, (int32), [ -2147483648 .. 2147483647 ]

Additional Validation Information:

This value must be set together with the following fields: post_completion_addon_percentage

Enum Descriptions:

  • 0 - As Of Planned Start Date

  • 1 - As Of Planned End Date

  • 2 - As Of Confirmed Start Date

  • 3 - As Of Confirmed End Date

Enum:0123
while_active_discount_percentage_modeinteger or null, (int32), [ -2147483648 .. 2147483647 ]

Additional Validation Information:

This value must be set together with the following fields: while_active_discount_percentage

Enum Descriptions:

  • 0 - As Of Planned Start Date

  • 1 - As Of Planned End Date

  • 2 - As Of Confirmed Start Date

  • 3 - As Of Confirmed End Date

Enum:0123
confirmed_end_datestring or null, (date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: confirmed_start_date

confirmed_start_datestring or null, (date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: confirmed_end_date

post_completion_addon_percentagenumber or null, (float)

Additional Validation Information:

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

This value must be set together with the following fields: post_completion_addon_percentage_mode

This value requires that the following fields are also set: article

common_areaobject or null(Commonarea)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment, brf_apartment, industrial_premises, outdoor_section, parking_spot

This field, or at least one of the following fields must be set: apartment, brf_apartment, industrial_premises, outdoor_section, parking_spot

industrial_premisesobject or null(Industrialpremises)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment, brf_apartment, outdoor_section, common_area, parking_spot

This field, or at least one of the following fields must be set: apartment, brf_apartment, outdoor_section, common_area, parking_spot

blocks_errandsboolean
outdoor_sectionobject or null(Outdoorsection)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment, brf_apartment, industrial_premises, common_area, parking_spot

This field, or at least one of the following fields must be set: apartment, brf_apartment, industrial_premises, common_area, parking_spot

apartmentobject or null(Apartment)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: brf_apartment, industrial_premises, outdoor_section, common_area, parking_spot

This field, or at least one of the following fields must be set: brf_apartment, industrial_premises, outdoor_section, common_area, parking_spot

while_active_discount_valuenumber or null, (float)

Additional Validation Information:

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

This value requires that the following fields are also set: article

brf_apartmentobject or null(Brfapartment)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment, industrial_premises, outdoor_section, common_area, parking_spot

This field, or at least one of the following fields must be set: apartment, industrial_premises, outdoor_section, common_area, parking_spot

articleobject or null(Article)
blocks_object_utilizationboolean
while_active_discount_percentagenumber or null, (float)

Additional Validation Information:

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

This value must be set together with the following fields: while_active_discount_percentage_mode

This value requires that the following fields are also set: article

descriptionstring or null
organizationobject or null(Organization)
parking_spotobject or null(Parkingspot)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment, brf_apartment, industrial_premises, outdoor_section, common_area

This field, or at least one of the following fields must be set: apartment, brf_apartment, industrial_premises, outdoor_section, common_area

POST
/objects/renovation/spacerenovationnotation/
curl -i -X POST \
  https://dev.api.pigello.io/objects/renovation/spacerenovationnotation/ \
  -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 '{
    "post_completion_addon_value": 0.1,
    "custom_id": "string",
    "post_completion_addon_percentage_mode": 0,
    "while_active_discount_percentage_mode": 0,
    "confirmed_end_date": "2019-08-24",
    "confirmed_start_date": "2019-08-24",
    "post_completion_addon_percentage": 0.1,
    "common_area": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "planned_end_date": "2019-08-24",
    "industrial_premises": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "blocks_errands": true,
    "outdoor_section": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "name": "string",
    "planned_start_date": "2019-08-24",
    "apartment": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "while_active_discount_value": 0.1,
    "brf_apartment": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "article": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "blocks_object_utilization": true,
    "while_active_discount_percentage": 0.1,
    "description": "string",
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "parking_spot": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    }
  }'

Responses

Successful creation

Bodyapplication/json
planned_end_datestring, (date)required

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: planned_start_date

namestring, <= 255 charactersrequired
idstring, (uuid)read-onlyrequired

Additional Validation Information:

Must be unique

planned_start_datestring, (date)required

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: planned_end_date

post_completion_addon_valuenumber or null, (float)

Additional Validation Information:

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

This value requires that the following fields are also set: article

custom_idstring or null, <= 128 characters
post_completion_addon_percentage_modeinteger or null, (int32), [ -2147483648 .. 2147483647 ]

Additional Validation Information:

This value must be set together with the following fields: post_completion_addon_percentage

Enum Descriptions:

  • 0 - As Of Planned Start Date

  • 1 - As Of Planned End Date

  • 2 - As Of Confirmed Start Date

  • 3 - As Of Confirmed End Date

Enum:0123
while_active_discount_percentage_modeinteger or null, (int32), [ -2147483648 .. 2147483647 ]

Additional Validation Information:

This value must be set together with the following fields: while_active_discount_percentage

Enum Descriptions:

  • 0 - As Of Planned Start Date

  • 1 - As Of Planned End Date

  • 2 - As Of Confirmed Start Date

  • 3 - As Of Confirmed End Date

Enum:0123
confirmed_end_datestring or null, (date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: confirmed_start_date

confirmed_start_datestring or null, (date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: confirmed_end_date

created_atstring, (date-time)read-only
post_completion_addon_percentagenumber or null, (float)

Additional Validation Information:

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

This value must be set together with the following fields: post_completion_addon_percentage_mode

This value requires that the following fields are also set: article

common_areaobject or null(Commonarea)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment, brf_apartment, industrial_premises, outdoor_section, parking_spot

This field, or at least one of the following fields must be set: apartment, brf_apartment, industrial_premises, outdoor_section, parking_spot

industrial_premisesobject or null(Industrialpremises)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment, brf_apartment, outdoor_section, common_area, parking_spot

This field, or at least one of the following fields must be set: apartment, brf_apartment, outdoor_section, common_area, parking_spot

blocks_errandsboolean
outdoor_sectionobject or null(Outdoorsection)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment, brf_apartment, industrial_premises, common_area, parking_spot

This field, or at least one of the following fields must be set: apartment, brf_apartment, industrial_premises, common_area, parking_spot

pending_monitor_approval_amountanyread-only
customer_columnsanyread-only
apartmentobject or null(Apartment)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: brf_apartment, industrial_premises, outdoor_section, common_area, parking_spot

This field, or at least one of the following fields must be set: brf_apartment, industrial_premises, outdoor_section, common_area, parking_spot

tagsanyread-only
while_active_discount_valuenumber or null, (float)

Additional Validation Information:

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

This value requires that the following fields are also set: article

brf_apartmentobject or null(Brfapartment)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment, industrial_premises, outdoor_section, common_area, parking_spot

This field, or at least one of the following fields must be set: apartment, industrial_premises, outdoor_section, common_area, parking_spot

articleobject or null(Article)
blocks_object_utilizationboolean
while_active_discount_percentagenumber or null, (float)

Additional Validation Information:

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

This value must be set together with the following fields: while_active_discount_percentage_mode

This value requires that the following fields are also set: article

descriptionstring or null
organizationobject or null(Organization)
parking_spotobject or null(Parkingspot)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment, brf_apartment, industrial_premises, outdoor_section, common_area

This field, or at least one of the following fields must be set: apartment, brf_apartment, industrial_premises, outdoor_section, common_area

Response
{
  "post_completion_addon_value": 0.1,
  "custom_id": "string",
  "post_completion_addon_percentage_mode": 0,
  "while_active_discount_percentage_mode": 0,
  "confirmed_end_date": "2019-08-24",
  "confirmed_start_date": "2019-08-24",
  "created_at": "2019-08-24T14:15:22Z",
  "post_completion_addon_percentage": 0.1,
  "common_area": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "planned_end_date": "2019-08-24",
  "industrial_premises": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "blocks_errands": true,
  "outdoor_section": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "name": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "planned_start_date": "2019-08-24",
  "pending_monitor_approval_amount": null,
  "customer_columns": null,
  "apartment": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "tags": null,
  "while_active_discount_value": 0.1,
  "brf_apartment": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "article": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "blocks_object_utilization": true,
  "while_active_discount_percentage": 0.1,
  "description": "string",
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "parking_spot": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  }
}
© Pigello. All rights reserved.