Skip to content

Corrigo: Location schemas

1 Corrigo schema with complete fields and constraints.

← Location operations · All schemas

Create location — request body — body entity

FieldTypePresenceDescription and constraints
$objectRoot
idintegerOptionalFormat: int32
isNewbooleanOptionalRead only: true
limitMultipleEntitiesNumberBehaviourbooleanOptional
performDeletionbooleanOptional
propertiesJSONOptional
properties (anyOf 1)arrayAlternative
properties (anyOf 1)[]JSONEach item
properties (anyOf 1)[] (anyOf 1)objectAlternativeA Corrigo PropertyTreeNode.
properties (anyOf 1)[] (anyOf 2)nullAlternative
properties (anyOf 2)nullAlternative
addressJSONOptional
address (anyOf 1)objectAlternativeA Corrigo Address2.
address (anyOf 2)nullAlternative
attributesJSONOptional
attributes (anyOf 1)arrayAlternative
attributes (anyOf 1)[]JSONEach item
attributes (anyOf 1)[] (anyOf 1)objectAlternativeA Corrigo AssetAttribute.
attributes (anyOf 1)[] (anyOf 2)nullAlternative
attributes (anyOf 2)nullAlternative
communityIdintegerOptionalFormat: int32
criticalFacilitiesstringOptionalOne of: No, Yes, Inherit
Format: int32
directPartsJSONOptional
directParts (anyOf 1)arrayAlternative
directParts (anyOf 1)[]JSONEach item
directParts (anyOf 1)[] (anyOf 1)objectAlternativeA Corrigo LinkProductAndQtyAttribute.
directParts (anyOf 1)[] (anyOf 2)nullAlternative
directParts (anyOf 2)nullAlternative
documentsJSONOptional
documents (anyOf 1)arrayAlternative
documents (anyOf 1)[]JSONEach item
documents (anyOf 1)[] (anyOf 1)objectAlternativeA Corrigo Document.
documents (anyOf 1)[] (anyOf 2)nullAlternative
documents (anyOf 2)nullAlternative
includeNonControllableExpensesbooleanOptional
infoJSONOptional
info (anyOf 1)objectAlternativeA Corrigo AssetInfo.
info (anyOf 2)nullAlternative
isDirectPartsbooleanOptional
isLockedbooleanOptional
isOfflinebooleanOptional
isRestrictedbooleanOptional
isTemplatebooleanOptional
modelIdintegerOptionalFormat: int32
nameJSONOptional
name (anyOf 1)stringAlternative
name (anyOf 2)nullAlternative
orphanbooleanOptional
parentIdintegerOptionalFormat: int32
rootIdintegerOptionalFormat: int32
typeIdstringOptionalOne of: Unknown, Regular, Building, Unit, Community, RoomArea, Floor, Utility, Equipment
Format: int32

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.