--- updatedAt: 2026-07-29T17:04:06.000Z agentTools: projectIndex: https://layer-api.readme.io/llms.txt --- # Batch Actions Executes multiple write operations sequentially in a single request. Actions are processed one at a time to avoid Firestore transaction contention. Each action can succeed or fail independently — check results[].status and summary.failed after the call. Actions the caller lacks permission for are reported as individual failures rather than rejecting the whole request; a caller with no access to the project at all receives a 403. # OpenAPI definition ```json { "openapi": "3.0.3", "info": { "termsOfService": "https://layer.team/terms-of-service", "title": "Layer API", "version": "0.3.0", "x-logo": { "altText": "Layer logo", "url": "https://layer.team/wp-content/themes/lessis/images/assets/layer-logo-footer.png" } }, "components": { "securitySchemes": { "bearerAuth": { "bearerFormat": "JWT", "scheme": "bearer", "type": "http" } } }, "paths": { "/projects/{projectId}/batch": { "post": { "operationId": "batchActions", "summary": "Batch Actions", "tags": [ "Batch" ], "description": "Executes multiple write operations sequentially in a single request. Actions are processed one at a time to avoid Firestore transaction contention. Each action can succeed or fail independently — check results[].status and summary.failed after the call. Actions the caller lacks permission for are reported as individual failures rather than rejecting the whole request; a caller with no access to the project at all receives a 403.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "actions" ], "properties": { "actions": { "description": "Actions to execute sequentially", "minItems": 1, "type": "array", "items": { "anyOf": [ { "type": "object", "required": [ "body", "tool" ], "properties": { "body": { "type": "object", "required": [ "name" ], "properties": { "initials": { "description": "Optional category initials. If omitted, the API derives them from the name.", "type": "string" }, "instance": { "description": "Optional singular instance label. If omitted, the API derives it from the name.", "type": "string" }, "name": { "description": "Category display name.", "type": "string" } } }, "tool": { "type": "string", "enum": [ "createCategory" ] } } }, { "type": "object", "required": [ "body", "tool" ], "properties": { "body": { "type": "object", "required": [ "category", "name" ], "properties": { "category": { "type": "object", "required": [ "id" ], "properties": { "id": { "description": "Element Category ID" } } }, "completed": { "type": "boolean" }, "fields": { "description": "Element field values. If fields in the category are omitted, those field values will be empty.", "type": "object", "additionalProperties": { "type": "object", "required": [ "value" ], "properties": { "value": { "description": "Field value. Select fields must be sent as an array of strings, even for single-select fields. The API accepts select option IDs or labels (for example [\"option-1\"] or [\"Open\"]) and normalizes them to option IDs; use [] to clear a select value. Manual related_v2 fields accept an ordered array of related element IDs, or an ordered array of objects with id and optional quantity." } } } }, "name": { "description": "Element name", "minLength": 1, "type": "string" }, "starred": { "type": "boolean" } } }, "tool": { "type": "string", "enum": [ "createElement" ] } } }, { "type": "object", "required": [ "body", "elementId", "tool" ], "properties": { "body": { "type": "object", "properties": { "completed": { "type": "boolean" }, "fields": { "description": "New element field values. If fields in the category are omitted, those field values will remain unchanged.", "type": "object", "additionalProperties": { "type": "object", "required": [ "value" ], "properties": { "value": { "description": "Field value. Select fields must be sent as an array of strings, even for single-select fields. The API accepts select option IDs or labels (for example [\"option-1\"] or [\"Open\"]) and normalizes them to option IDs; use [] to clear a select value. Manual related_v2 fields accept an ordered array of related element IDs, or an ordered array of objects with id and optional quantity." } } } }, "name": { "description": "New name of the element", "type": "string" }, "starred": { "type": "boolean" } } }, "elementId": { "description": "Element ID", "type": "string" }, "tool": { "type": "string", "enum": [ "updateElement" ] } } }, { "type": "object", "required": [ "elementId", "tool" ], "properties": { "elementId": { "description": "Element ID", "type": "string" }, "tool": { "type": "string", "enum": [ "deleteElement" ] } } }, { "type": "object", "required": [ "body", "categoryId", "tool" ], "properties": { "body": { "oneOf": [ { "type": "object", "required": [ "name", "type" ], "properties": { "displayType": { "description": "Defines who has access to the view", "enum": [ "DEFAULT", "EVERYONE", "JUST_ME" ], "type": "string" }, "name": { "description": "View name", "type": "string" }, "sort": { "description": "Initial sort configuration for the view", "type": "array", "items": { "type": "object", "required": [ "direction", "field" ], "properties": { "direction": { "description": "Sort direction", "anyOf": [ { "type": "string", "enum": [ "asc" ] }, { "type": "string", "enum": [ "desc" ] } ] }, "field": { "type": "object", "required": [ "id", "type" ], "properties": { "id": { "description": "Layer field ID or default field key", "type": "string" }, "type": { "description": "Layer field type to sort by", "anyOf": [ { "type": "string", "enum": [ "area" ] }, { "type": "string", "enum": [ "createdat" ] }, { "type": "string", "enum": [ "createdby" ] }, { "type": "string", "enum": [ "date" ] }, { "type": "string", "enum": [ "elementNumber" ] }, { "type": "string", "enum": [ "file" ] }, { "type": "string", "enum": [ "formula" ] }, { "type": "string", "enum": [ "formulaV2" ] }, { "type": "string", "enum": [ "modelName" ] }, { "type": "string", "enum": [ "number" ] }, { "type": "string", "enum": [ "person" ] }, { "type": "string", "enum": [ "range" ] }, { "type": "string", "enum": [ "references" ] }, { "type": "string", "enum": [ "related" ] }, { "type": "string", "enum": [ "relatedV2" ] }, { "type": "string", "enum": [ "select" ] }, { "type": "string", "enum": [ "spatialRelationships" ] }, { "type": "string", "enum": [ "text" ] }, { "type": "string", "enum": [ "toggle" ] }, { "type": "string", "enum": [ "updatedat" ] }, { "type": "string", "enum": [ "updatedby" ] }, { "type": "string", "enum": [ "LAYER_ELEMENT_NAME" ] }, { "type": "string", "enum": [ "LAYER_REVIT_PARAMETER" ] } ] } } } } } }, "filterConfig": { "type": "object", "required": [ "condition", "filters" ], "properties": { "condition": { "description": "Logical operator across all filters — 'AND' requires every filter to match, 'OR' requires at least one", "anyOf": [ { "type": "string", "enum": [ "AND" ] }, { "type": "string", "enum": [ "OR" ] } ] }, "filters": { "description": "Array of individual filter conditions", "type": "array", "items": { "oneOf": [ { "type": "object", "required": [ "clause", "field", "type" ], "properties": { "clause": { "description": "Array filter clause", "anyOf": [ { "type": "string", "enum": [ "ARRAY_CONTAINS" ] }, { "type": "string", "enum": [ "ARRAY_NOT_CONTAINS" ] }, { "type": "string", "enum": [ "ARRAY_IS" ] }, { "type": "string", "enum": [ "ARRAY_IS_NOT" ] }, { "type": "string", "enum": [ "ARRAY_IS_EMPTY" ] }, { "type": "string", "enum": [ "ARRAY_IS_NOT_EMPTY" ] } ] }, "field": { "type": "object", "required": [ "id", "type" ], "properties": { "categoryFilterId": { "type": "string" }, "id": { "description": "Layer field ID", "type": "string" }, "type": { "description": "Field types that support array filtering: select (option IDs), person/user (user refs), related (document refs), relatedV2 (element refs)", "anyOf": [ { "type": "string", "enum": [ "select" ] }, { "type": "string", "enum": [ "person" ] }, { "type": "string", "enum": [ "createdby" ] }, { "type": "string", "enum": [ "updatedby" ] }, { "type": "string", "enum": [ "related" ] }, { "type": "string", "enum": [ "relatedV2" ] } ] } } }, "type": { "type": "string", "enum": [ "ARRAY" ] }, "value": { "description": "Array of option IDs (select), user refs (person/user), or full element ref paths for related/relatedV2 fields — MUST be \"projects/{projectId}/elements/{elementId}\", never bare element IDs. Omit for IS_EMPTY / IS_NOT_EMPTY.", "type": "array", "items": { "type": "string" } } } }, { "type": "object", "required": [ "clause", "field", "type" ], "properties": { "clause": { "description": "Boolean filter clause", "anyOf": [ { "type": "string", "enum": [ "BOOL_IS" ] }, { "type": "string", "enum": [ "BOOL_IS_NOT" ] } ] }, "field": { "type": "object", "required": [ "id", "type" ], "properties": { "categoryFilterId": { "type": "string" }, "id": { "description": "Layer field ID", "type": "string" }, "type": { "description": "toggle — the only field type that supports boolean filtering", "type": "string", "enum": [ "toggle" ] } } }, "type": { "type": "string", "enum": [ "BOOLEAN" ] }, "value": { "description": "Boolean value to match", "type": "boolean" } } }, { "type": "object", "required": [ "clause", "field", "type" ], "properties": { "clause": { "description": "Date filter clause", "anyOf": [ { "type": "string", "enum": [ "DATE_IS" ] }, { "type": "string", "enum": [ "DATE_IS_BEFORE" ] }, { "type": "string", "enum": [ "DATE_IS_AFTER" ] }, { "type": "string", "enum": [ "DATE_IS_EMPTY" ] }, { "type": "string", "enum": [ "DATE_IS_NOT_EMPTY" ] }, { "type": "string", "enum": [ "DATE_IS_WITHIN" ] } ] }, "field": { "type": "object", "required": [ "id", "type" ], "properties": { "categoryFilterId": { "type": "string" }, "id": { "description": "Layer field ID", "type": "string" }, "type": { "description": "Field types that support date filtering", "anyOf": [ { "type": "string", "enum": [ "date" ] }, { "type": "string", "enum": [ "createdat" ] }, { "type": "string", "enum": [ "updatedat" ] } ] } } }, "type": { "type": "string", "enum": [ "DATE" ] }, "value": { "description": "Absolute date-time string or relative-date config (DATE_IS_WITHIN). Omit for IS_EMPTY / IS_NOT_EMPTY.", "anyOf": [ { "description": "ISO 8601 date-time string — use with DATE_IS, DATE_IS_BEFORE, DATE_IS_AFTER", "format": "date-time", "type": "string" }, { "description": "Relative-date value used with the DATE_IS_WITHIN clause", "type": "object", "required": [ "direction", "interval" ], "properties": { "direction": { "description": "Temporal direction — 'past': look back, 'next': look forward, 'this': current period", "anyOf": [ { "type": "string", "enum": [ "next" ] }, { "type": "string", "enum": [ "past" ] }, { "type": "string", "enum": [ "this" ] } ] }, "interval": { "description": "Calendar interval unit", "anyOf": [ { "type": "string", "enum": [ "days" ] }, { "type": "string", "enum": [ "months" ] }, { "type": "string", "enum": [ "weeks" ] }, { "type": "string", "enum": [ "years" ] } ] }, "intervalValue": { "description": "Number of intervals. Omit when direction is 'this'.", "type": "number" } } } ] } } }, { "type": "object", "required": [ "clause", "field", "type" ], "properties": { "clause": { "description": "Number filter clause", "anyOf": [ { "type": "string", "enum": [ "==" ] }, { "type": "string", "enum": [ "!=" ] }, { "type": "string", "enum": [ "<" ] }, { "type": "string", "enum": [ "<=" ] }, { "type": "string", "enum": [ ">" ] }, { "type": "string", "enum": [ ">=" ] }, { "type": "string", "enum": [ "NUMBER_IS_EMPTY" ] }, { "type": "string", "enum": [ "NUMBER_IS_NOT_EMPTY" ] } ] }, "field": { "type": "object", "required": [ "id", "type" ], "properties": { "categoryFilterId": { "type": "string" }, "id": { "description": "Layer field ID", "type": "string" }, "type": { "description": "Field types that support number filtering", "anyOf": [ { "type": "string", "enum": [ "number" ] }, { "type": "string", "enum": [ "range" ] }, { "type": "string", "enum": [ "elementNumber" ] } ] } } }, "type": { "type": "string", "enum": [ "NUMBER" ] }, "value": { "description": "Numeric value to compare against. Omit for IS_EMPTY / IS_NOT_EMPTY.", "type": "number" } } }, { "type": "object", "required": [ "clause", "field", "type" ], "properties": { "clause": { "description": "Reference filter clause — presence-only checks; no value field required", "anyOf": [ { "type": "string", "enum": [ "REFERENCE_IS_EMPTY" ] }, { "type": "string", "enum": [ "REFERENCE_IS_NOT_EMPTY" ] } ] }, "field": { "type": "object", "required": [ "id", "type" ], "properties": { "categoryFilterId": { "type": "string" }, "id": { "description": "Layer field ID", "type": "string" }, "type": { "description": "Field types that support reference filtering", "type": "string", "enum": [ "references" ] } } }, "type": { "type": "string", "enum": [ "REFERENCE" ] } } }, { "type": "object", "required": [ "clause", "field", "type" ], "properties": { "clause": { "description": "Spatial filter clause", "anyOf": [ { "type": "string", "enum": [ "SPATIAL_CONTAINS" ] }, { "type": "string", "enum": [ "SPATIAL_NOT_CONTAINS" ] }, { "type": "string", "enum": [ "SPATIAL_IS" ] }, { "type": "string", "enum": [ "SPATIAL_IS_NOT" ] }, { "type": "string", "enum": [ "SPATIAL_IS_EMPTY" ] }, { "type": "string", "enum": [ "SPATIAL_IS_NOT_EMPTY" ] } ] }, "field": { "type": "object", "required": [ "id", "type" ], "properties": { "categoryFilterId": { "type": "string" }, "id": { "description": "Layer field ID", "type": "string" }, "type": { "description": "spatialRelationships — the only field type that supports spatial filtering", "type": "string", "enum": [ "spatialRelationships" ] } } }, "type": { "type": "string", "enum": [ "SPATIAL" ] }, "value": { "description": "Spatial element ID(s). Omit for IS_EMPTY / IS_NOT_EMPTY.", "anyOf": [ { "description": "Single spatial element ID", "type": "string" }, { "description": "Multiple spatial element IDs", "type": "array", "items": { "type": "string" } } ] } } }, { "type": "object", "required": [ "clause", "field", "type" ], "properties": { "clause": { "description": "Text filter clause", "anyOf": [ { "type": "string", "enum": [ "TEXT_CONTAINS" ] }, { "type": "string", "enum": [ "TEXT_NOT_CONTAINS" ] }, { "type": "string", "enum": [ "TEXT_STARTS_WITH" ] }, { "type": "string", "enum": [ "TEXT_IS" ] }, { "type": "string", "enum": [ "TEXT_IS_NOT" ] }, { "type": "string", "enum": [ "TEXT_IS_EMPTY" ] }, { "type": "string", "enum": [ "TEXT_IS_NOT_EMPTY" ] } ] }, "field": { "type": "object", "required": [ "id", "type" ], "properties": { "categoryFilterId": { "type": "string" }, "id": { "description": "Layer field ID", "type": "string" }, "type": { "description": "Field types that support text filtering", "anyOf": [ { "type": "string", "enum": [ "text" ] }, { "type": "string", "enum": [ "area" ] }, { "type": "string", "enum": [ "barcode" ] }, { "type": "string", "enum": [ "email" ] }, { "type": "string", "enum": [ "phone" ] }, { "type": "string", "enum": [ "revitParam" ] }, { "type": "string", "enum": [ "LAYER_ELEMENT_NAME" ] }, { "type": "string", "enum": [ "LAYER_REVIT_PARAMETER" ] } ] } } }, "type": { "type": "string", "enum": [ "TEXT" ] }, "value": { "description": "Text value to match against. Omit for IS_EMPTY / IS_NOT_EMPTY.", "type": "string" } } } ], "type": "object" } } } }, "type": { "type": "string", "enum": [ "DOCUMENT" ] } } }, { "type": "object", "required": [ "name", "type" ], "properties": { "displayType": { "description": "Defines who has access to the view", "enum": [ "DEFAULT", "EVERYONE", "JUST_ME" ], "type": "string" }, "name": { "description": "View name", "type": "string" }, "sort": { "description": "Initial sort configuration for the view", "type": "array", "items": { "type": "object", "required": [ "direction", "field" ], "properties": { "direction": { "description": "Sort direction", "anyOf": [ { "type": "string", "enum": [ "asc" ] }, { "type": "string", "enum": [ "desc" ] } ] }, "field": { "type": "object", "required": [ "id", "type" ], "properties": { "id": { "description": "Layer field ID or default field key", "type": "string" }, "type": { "description": "Layer field type to sort by", "anyOf": [ { "type": "string", "enum": [ "area" ] }, { "type": "string", "enum": [ "createdat" ] }, { "type": "string", "enum": [ "createdby" ] }, { "type": "string", "enum": [ "date" ] }, { "type": "string", "enum": [ "elementNumber" ] }, { "type": "string", "enum": [ "file" ] }, { "type": "string", "enum": [ "formula" ] }, { "type": "string", "enum": [ "formulaV2" ] }, { "type": "string", "enum": [ "modelName" ] }, { "type": "string", "enum": [ "number" ] }, { "type": "string", "enum": [ "person" ] }, { "type": "string", "enum": [ "range" ] }, { "type": "string", "enum": [ "references" ] }, { "type": "string", "enum": [ "related" ] }, { "type": "string", "enum": [ "relatedV2" ] }, { "type": "string", "enum": [ "select" ] }, { "type": "string", "enum": [ "spatialRelationships" ] }, { "type": "string", "enum": [ "text" ] }, { "type": "string", "enum": [ "toggle" ] }, { "type": "string", "enum": [ "updatedat" ] }, { "type": "string", "enum": [ "updatedby" ] }, { "type": "string", "enum": [ "LAYER_ELEMENT_NAME" ] }, { "type": "string", "enum": [ "LAYER_REVIT_PARAMETER" ] } ] } } } } } }, "filterConfig": { "type": "object", "required": [ "condition", "filters" ], "properties": { "condition": { "description": "Logical operator across all filters — 'AND' requires every filter to match, 'OR' requires at least one", "anyOf": [ { "type": "string", "enum": [ "AND" ] }, { "type": "string", "enum": [ "OR" ] } ] }, "filters": { "description": "Array of individual filter conditions", "type": "array", "items": { "oneOf": [ { "type": "object", "required": [ "clause", "field", "type" ], "properties": { "clause": { "description": "Array filter clause", "anyOf": [ { "type": "string", "enum": [ "ARRAY_CONTAINS" ] }, { "type": "string", "enum": [ "ARRAY_NOT_CONTAINS" ] }, { "type": "string", "enum": [ "ARRAY_IS" ] }, { "type": "string", "enum": [ "ARRAY_IS_NOT" ] }, { "type": "string", "enum": [ "ARRAY_IS_EMPTY" ] }, { "type": "string", "enum": [ "ARRAY_IS_NOT_EMPTY" ] } ] }, "field": { "type": "object", "required": [ "id", "type" ], "properties": { "categoryFilterId": { "type": "string" }, "id": { "description": "Layer field ID", "type": "string" }, "type": { "description": "Field types that support array filtering: select (option IDs), person/user (user refs), related (document refs), relatedV2 (element refs)", "anyOf": [ { "type": "string", "enum": [ "select" ] }, { "type": "string", "enum": [ "person" ] }, { "type": "string", "enum": [ "createdby" ] }, { "type": "string", "enum": [ "updatedby" ] }, { "type": "string", "enum": [ "related" ] }, { "type": "string", "enum": [ "relatedV2" ] } ] } } }, "type": { "type": "string", "enum": [ "ARRAY" ] }, "value": { "description": "Array of option IDs (select), user refs (person/user), or full element ref paths for related/relatedV2 fields — MUST be \"projects/{projectId}/elements/{elementId}\", never bare element IDs. Omit for IS_EMPTY / IS_NOT_EMPTY.", "type": "array", "items": { "type": "string" } } } }, { "type": "object", "required": [ "clause", "field", "type" ], "properties": { "clause": { "description": "Boolean filter clause", "anyOf": [ { "type": "string", "enum": [ "BOOL_IS" ] }, { "type": "string", "enum": [ "BOOL_IS_NOT" ] } ] }, "field": { "type": "object", "required": [ "id", "type" ], "properties": { "categoryFilterId": { "type": "string" }, "id": { "description": "Layer field ID", "type": "string" }, "type": { "description": "toggle — the only field type that supports boolean filtering", "type": "string", "enum": [ "toggle" ] } } }, "type": { "type": "string", "enum": [ "BOOLEAN" ] }, "value": { "description": "Boolean value to match", "type": "boolean" } } }, { "type": "object", "required": [ "clause", "field", "type" ], "properties": { "clause": { "description": "Date filter clause", "anyOf": [ { "type": "string", "enum": [ "DATE_IS" ] }, { "type": "string", "enum": [ "DATE_IS_BEFORE" ] }, { "type": "string", "enum": [ "DATE_IS_AFTER" ] }, { "type": "string", "enum": [ "DATE_IS_EMPTY" ] }, { "type": "string", "enum": [ "DATE_IS_NOT_EMPTY" ] }, { "type": "string", "enum": [ "DATE_IS_WITHIN" ] } ] }, "field": { "type": "object", "required": [ "id", "type" ], "properties": { "categoryFilterId": { "type": "string" }, "id": { "description": "Layer field ID", "type": "string" }, "type": { "description": "Field types that support date filtering", "anyOf": [ { "type": "string", "enum": [ "date" ] }, { "type": "string", "enum": [ "createdat" ] }, { "type": "string", "enum": [ "updatedat" ] } ] } } }, "type": { "type": "string", "enum": [ "DATE" ] }, "value": { "description": "Absolute date-time string or relative-date config (DATE_IS_WITHIN). Omit for IS_EMPTY / IS_NOT_EMPTY.", "anyOf": [ { "description": "ISO 8601 date-time string — use with DATE_IS, DATE_IS_BEFORE, DATE_IS_AFTER", "format": "date-time", "type": "string" }, { "description": "Relative-date value used with the DATE_IS_WITHIN clause", "type": "object", "required": [ "direction", "interval" ], "properties": { "direction": { "description": "Temporal direction — 'past': look back, 'next': look forward, 'this': current period", "anyOf": [ { "type": "string", "enum": [ "next" ] }, { "type": "string", "enum": [ "past" ] }, { "type": "string", "enum": [ "this" ] } ] }, "interval": { "description": "Calendar interval unit", "anyOf": [ { "type": "string", "enum": [ "days" ] }, { "type": "string", "enum": [ "months" ] }, { "type": "string", "enum": [ "weeks" ] }, { "type": "string", "enum": [ "years" ] } ] }, "intervalValue": { "description": "Number of intervals. Omit when direction is 'this'.", "type": "number" } } } ] } } }, { "type": "object", "required": [ "clause", "field", "type" ], "properties": { "clause": { "description": "Number filter clause", "anyOf": [ { "type": "string", "enum": [ "==" ] }, { "type": "string", "enum": [ "!=" ] }, { "type": "string", "enum": [ "<" ] }, { "type": "string", "enum": [ "<=" ] }, { "type": "string", "enum": [ ">" ] }, { "type": "string", "enum": [ ">=" ] }, { "type": "string", "enum": [ "NUMBER_IS_EMPTY" ] }, { "type": "string", "enum": [ "NUMBER_IS_NOT_EMPTY" ] } ] }, "field": { "type": "object", "required": [ "id", "type" ], "properties": { "categoryFilterId": { "type": "string" }, "id": { "description": "Layer field ID", "type": "string" }, "type": { "description": "Field types that support number filtering", "anyOf": [ { "type": "string", "enum": [ "number" ] }, { "type": "string", "enum": [ "range" ] }, { "type": "string", "enum": [ "elementNumber" ] } ] } } }, "type": { "type": "string", "enum": [ "NUMBER" ] }, "value": { "description": "Numeric value to compare against. Omit for IS_EMPTY / IS_NOT_EMPTY.", "type": "number" } } }, { "type": "object", "required": [ "clause", "field", "type" ], "properties": { "clause": { "description": "Reference filter clause — presence-only checks; no value field required", "anyOf": [ { "type": "string", "enum": [ "REFERENCE_IS_EMPTY" ] }, { "type": "string", "enum": [ "REFERENCE_IS_NOT_EMPTY" ] } ] }, "field": { "type": "object", "required": [ "id", "type" ], "properties": { "categoryFilterId": { "type": "string" }, "id": { "description": "Layer field ID", "type": "string" }, "type": { "description": "Field types that support reference filtering", "type": "string", "enum": [ "references" ] } } }, "type": { "type": "string", "enum": [ "REFERENCE" ] } } }, { "type": "object", "required": [ "clause", "field", "type" ], "properties": { "clause": { "description": "Spatial filter clause", "anyOf": [ { "type": "string", "enum": [ "SPATIAL_CONTAINS" ] }, { "type": "string", "enum": [ "SPATIAL_NOT_CONTAINS" ] }, { "type": "string", "enum": [ "SPATIAL_IS" ] }, { "type": "string", "enum": [ "SPATIAL_IS_NOT" ] }, { "type": "string", "enum": [ "SPATIAL_IS_EMPTY" ] }, { "type": "string", "enum": [ "SPATIAL_IS_NOT_EMPTY" ] } ] }, "field": { "type": "object", "required": [ "id", "type" ], "properties": { "categoryFilterId": { "type": "string" }, "id": { "description": "Layer field ID", "type": "string" }, "type": { "description": "spatialRelationships — the only field type that supports spatial filtering", "type": "string", "enum": [ "spatialRelationships" ] } } }, "type": { "type": "string", "enum": [ "SPATIAL" ] }, "value": { "description": "Spatial element ID(s). Omit for IS_EMPTY / IS_NOT_EMPTY.", "anyOf": [ { "description": "Single spatial element ID", "type": "string" }, { "description": "Multiple spatial element IDs", "type": "array", "items": { "type": "string" } } ] } } }, { "type": "object", "required": [ "clause", "field", "type" ], "properties": { "clause": { "description": "Text filter clause", "anyOf": [ { "type": "string", "enum": [ "TEXT_CONTAINS" ] }, { "type": "string", "enum": [ "TEXT_NOT_CONTAINS" ] }, { "type": "string", "enum": [ "TEXT_STARTS_WITH" ] }, { "type": "string", "enum": [ "TEXT_IS" ] }, { "type": "string", "enum": [ "TEXT_IS_NOT" ] }, { "type": "string", "enum": [ "TEXT_IS_EMPTY" ] }, { "type": "string", "enum": [ "TEXT_IS_NOT_EMPTY" ] } ] }, "field": { "type": "object", "required": [ "id", "type" ], "properties": { "categoryFilterId": { "type": "string" }, "id": { "description": "Layer field ID", "type": "string" }, "type": { "description": "Field types that support text filtering", "anyOf": [ { "type": "string", "enum": [ "text" ] }, { "type": "string", "enum": [ "area" ] }, { "type": "string", "enum": [ "barcode" ] }, { "type": "string", "enum": [ "email" ] }, { "type": "string", "enum": [ "phone" ] }, { "type": "string", "enum": [ "revitParam" ] }, { "type": "string", "enum": [ "LAYER_ELEMENT_NAME" ] }, { "type": "string", "enum": [ "LAYER_REVIT_PARAMETER" ] } ] } } }, "type": { "type": "string", "enum": [ "TEXT" ] }, "value": { "description": "Text value to match against. Omit for IS_EMPTY / IS_NOT_EMPTY.", "type": "string" } } } ], "type": "object" } } } }, "type": { "type": "string", "enum": [ "DRAWING" ] } } }, { "type": "object", "required": [ "name", "type" ], "properties": { "displayType": { "description": "Defines who has access to the view", "enum": [ "DEFAULT", "EVERYONE", "JUST_ME" ], "type": "string" }, "name": { "description": "View name", "type": "string" }, "sort": { "description": "Initial sort configuration for the view", "type": "array", "items": { "type": "object", "required": [ "direction", "field" ], "properties": { "direction": { "description": "Sort direction", "anyOf": [ { "type": "string", "enum": [ "asc" ] }, { "type": "string", "enum": [ "desc" ] } ] }, "field": { "type": "object", "required": [ "id", "type" ], "properties": { "id": { "description": "Layer field ID or default field key", "type": "string" }, "type": { "description": "Layer field type to sort by", "anyOf": [ { "type": "string", "enum": [ "area" ] }, { "type": "string", "enum": [ "createdat" ] }, { "type": "string", "enum": [ "createdby" ] }, { "type": "string", "enum": [ "date" ] }, { "type": "string", "enum": [ "elementNumber" ] }, { "type": "string", "enum": [ "file" ] }, { "type": "string", "enum": [ "formula" ] }, { "type": "string", "enum": [ "formulaV2" ] }, { "type": "string", "enum": [ "modelName" ] }, { "type": "string", "enum": [ "number" ] }, { "type": "string", "enum": [ "person" ] }, { "type": "string", "enum": [ "range" ] }, { "type": "string", "enum": [ "references" ] }, { "type": "string", "enum": [ "related" ] }, { "type": "string", "enum": [ "relatedV2" ] }, { "type": "string", "enum": [ "select" ] }, { "type": "string", "enum": [ "spatialRelationships" ] }, { "type": "string", "enum": [ "text" ] }, { "type": "string", "enum": [ "toggle" ] }, { "type": "string", "enum": [ "updatedat" ] }, { "type": "string", "enum": [ "updatedby" ] }, { "type": "string", "enum": [ "LAYER_ELEMENT_NAME" ] }, { "type": "string", "enum": [ "LAYER_REVIT_PARAMETER" ] } ] } } } } } }, "fieldDisplay": { "description": "fieldDisplay is not supported for FORM views. Form layout is configured via blocks on form pages (formConfig.formPages[].blocks), not fieldDisplay.", "not": {} }, "filterConfig": { "description": "Top-level filterConfig is not supported for FORM views. Use per-block filterConfig within formConfig for related fields instead.", "not": {} }, "type": { "type": "string", "enum": [ "FORM" ] } } }, { "type": "object", "required": [ "name", "type" ], "properties": { "displayType": { "description": "Defines who has access to the view", "enum": [ "DEFAULT", "EVERYONE", "JUST_ME" ], "type": "string" }, "name": { "description": "View name", "type": "string" }, "sort": { "description": "Initial sort configuration for the view", "type": "array", "items": { "type": "object", "required": [ "direction", "field" ], "properties": { "direction": { "description": "Sort direction", "anyOf": [ { "type": "string", "enum": [ "asc" ] }, { "type": "string", "enum": [ "desc" ] } ] }, "field": { "type": "object", "required": [ "id", "type" ], "properties": { "id": { "description": "Layer field ID or default field key", "type": "string" }, "type": { "description": "Layer field type to sort by", "anyOf": [ { "type": "string", "enum": [ "area" ] }, { "type": "string", "enum": [ "createdat" ] }, { "type": "string", "enum": [ "createdby" ] }, { "type": "string", "enum": [ "date" ] }, { "type": "string", "enum": [ "elementNumber" ] }, { "type": "string", "enum": [ "file" ] }, { "type": "string", "enum": [ "formula" ] }, { "type": "string", "enum": [ "formulaV2" ] }, { "type": "string", "enum": [ "modelName" ] }, { "type": "string", "enum": [ "number" ] }, { "type": "string", "enum": [ "person" ] }, { "type": "string", "enum": [ "range" ] }, { "type": "string", "enum": [ "references" ] }, { "type": "string", "enum": [ "related" ] }, { "type": "string", "enum": [ "relatedV2" ] }, { "type": "string", "enum": [ "select" ] }, { "type": "string", "enum": [ "spatialRelationships" ] }, { "type": "string", "enum": [ "text" ] }, { "type": "string", "enum": [ "toggle" ] }, { "type": "string", "enum": [ "updatedat" ] }, { "type": "string", "enum": [ "updatedby" ] }, { "type": "string", "enum": [ "LAYER_ELEMENT_NAME" ] }, { "type": "string", "enum": [ "LAYER_REVIT_PARAMETER" ] } ] } } } } } }, "filterConfig": { "type": "object", "required": [ "condition", "filters" ], "properties": { "condition": { "description": "Logical operator across all filters — 'AND' requires every filter to match, 'OR' requires at least one", "anyOf": [ { "type": "string", "enum": [ "AND" ] }, { "type": "string", "enum": [ "OR" ] } ] }, "filters": { "description": "Array of individual filter conditions", "type": "array", "items": { "oneOf": [ { "type": "object", "required": [ "clause", "field", "type" ], "properties": { "clause": { "description": "Array filter clause", "anyOf": [ { "type": "string", "enum": [ "ARRAY_CONTAINS" ] }, { "type": "string", "enum": [ "ARRAY_NOT_CONTAINS" ] }, { "type": "string", "enum": [ "ARRAY_IS" ] }, { "type": "string", "enum": [ "ARRAY_IS_NOT" ] }, { "type": "string", "enum": [ "ARRAY_IS_EMPTY" ] }, { "type": "string", "enum": [ "ARRAY_IS_NOT_EMPTY" ] } ] }, "field": { "type": "object", "required": [ "id", "type" ], "properties": { "categoryFilterId": { "type": "string" }, "id": { "description": "Layer field ID", "type": "string" }, "type": { "description": "Field types that support array filtering: select (option IDs), person/user (user refs), related (document refs), relatedV2 (element refs)", "anyOf": [ { "type": "string", "enum": [ "select" ] }, { "type": "string", "enum": [ "person" ] }, { "type": "string", "enum": [ "createdby" ] }, { "type": "string", "enum": [ "updatedby" ] }, { "type": "string", "enum": [ "related" ] }, { "type": "string", "enum": [ "relatedV2" ] } ] } } }, "type": { "type": "string", "enum": [ "ARRAY" ] }, "value": { "description": "Array of option IDs (select), user refs (person/user), or full element ref paths for related/relatedV2 fields — MUST be \"projects/{projectId}/elements/{elementId}\", never bare element IDs. Omit for IS_EMPTY / IS_NOT_EMPTY.", "type": "array", "items": { "type": "string" } } } }, { "type": "object", "required": [ "clause", "field", "type" ], "properties": { "clause": { "description": "Boolean filter clause", "anyOf": [ { "type": "string", "enum": [ "BOOL_IS" ] }, { "type": "string", "enum": [ "BOOL_IS_NOT" ] } ] }, "field": { "type": "object", "required": [ "id", "type" ], "properties": { "categoryFilterId": { "type": "string" }, "id": { "description": "Layer field ID", "type": "string" }, "type": { "description": "toggle — the only field type that supports boolean filtering", "type": "string", "enum": [ "toggle" ] } } }, "type": { "type": "string", "enum": [ "BOOLEAN" ] }, "value": { "description": "Boolean value to match", "type": "boolean" } } }, { "type": "object", "required": [ "clause", "field", "type" ], "properties": { "clause": { "description": "Date filter clause", "anyOf": [ { "type": "string", "enum": [ "DATE_IS" ] }, { "type": "string", "enum": [ "DATE_IS_BEFORE" ] }, { "type": "string", "enum": [ "DATE_IS_AFTER" ] }, { "type": "string", "enum": [ "DATE_IS_EMPTY" ] }, { "type": "string", "enum": [ "DATE_IS_NOT_EMPTY" ] }, { "type": "string", "enum": [ "DATE_IS_WITHIN" ] } ] }, "field": { "type": "object", "required": [ "id", "type" ], "properties": { "categoryFilterId": { "type": "string" }, "id": { "description": "Layer field ID", "type": "string" }, "type": { "description": "Field types that support date filtering", "anyOf": [ { "type": "string", "enum": [ "date" ] }, { "type": "string", "enum": [ "createdat" ] }, { "type": "string", "enum": [ "updatedat" ] } ] } } }, "type": { "type": "string", "enum": [ "DATE" ] }, "value": { "description": "Absolute date-time string or relative-date config (DATE_IS_WITHIN). Omit for IS_EMPTY / IS_NOT_EMPTY.", "anyOf": [ { "description": "ISO 8601 date-time string — use with DATE_IS, DATE_IS_BEFORE, DATE_IS_AFTER", "format": "date-time", "type": "string" }, { "description": "Relative-date value used with the DATE_IS_WITHIN clause", "type": "object", "required": [ "direction", "interval" ], "properties": { "direction": { "description": "Temporal direction — 'past': look back, 'next': look forward, 'this': current period", "anyOf": [ { "type": "string", "enum": [ "next" ] }, { "type": "string", "enum": [ "past" ] }, { "type": "string", "enum": [ "this" ] } ] }, "interval": { "description": "Calendar interval unit", "anyOf": [ { "type": "string", "enum": [ "days" ] }, { "type": "string", "enum": [ "months" ] }, { "type": "string", "enum": [ "weeks" ] }, { "type": "string", "enum": [ "years" ] } ] }, "intervalValue": { "description": "Number of intervals. Omit when direction is 'this'.", "type": "number" } } } ] } } }, { "type": "object", "required": [ "clause", "field", "type" ], "properties": { "clause": { "description": "Number filter clause", "anyOf": [ { "type": "string", "enum": [ "==" ] }, { "type": "string", "enum": [ "!=" ] }, { "type": "string", "enum": [ "<" ] }, { "type": "string", "enum": [ "<=" ] }, { "type": "string", "enum": [ ">" ] }, { "type": "string", "enum": [ ">=" ] }, { "type": "string", "enum": [ "NUMBER_IS_EMPTY" ] }, { "type": "string", "enum": [ "NUMBER_IS_NOT_EMPTY" ] } ] }, "field": { "type": "object", "required": [ "id", "type" ], "properties": { "categoryFilterId": { "type": "string" }, "id": { "description": "Layer field ID", "type": "string" }, "type": { "description": "Field types that support number filtering", "anyOf": [ { "type": "string", "enum": [ "number" ] }, { "type": "string", "enum": [ "range" ] }, { "type": "string", "enum": [ "elementNumber" ] } ] } } }, "type": { "type": "string", "enum": [ "NUMBER" ] }, "value": { "description": "Numeric value to compare against. Omit for IS_EMPTY / IS_NOT_EMPTY.", "type": "number" } } }, { "type": "object", "required": [ "clause", "field", "type" ], "properties": { "clause": { "description": "Reference filter clause — presence-only checks; no value field required", "anyOf": [ { "type": "string", "enum": [ "REFERENCE_IS_EMPTY" ] }, { "type": "string", "enum": [ "REFERENCE_IS_NOT_EMPTY" ] } ] }, "field": { "type": "object", "required": [ "id", "type" ], "properties": { "categoryFilterId": { "type": "string" }, "id": { "description": "Layer field ID", "type": "string" }, "type": { "description": "Field types that support reference filtering", "type": "string", "enum": [ "references" ] } } }, "type": { "type": "string", "enum": [ "REFERENCE" ] } } }, { "type": "object", "required": [ "clause", "field", "type" ], "properties": { "clause": { "description": "Spatial filter clause", "anyOf": [ { "type": "string", "enum": [ "SPATIAL_CONTAINS" ] }, { "type": "string", "enum": [ "SPATIAL_NOT_CONTAINS" ] }, { "type": "string", "enum": [ "SPATIAL_IS" ] }, { "type": "string", "enum": [ "SPATIAL_IS_NOT" ] }, { "type": "string", "enum": [ "SPATIAL_IS_EMPTY" ] }, { "type": "string", "enum": [ "SPATIAL_IS_NOT_EMPTY" ] } ] }, "field": { "type": "object", "required": [ "id", "type" ], "properties": { "categoryFilterId": { "type": "string" }, "id": { "description": "Layer field ID", "type": "string" }, "type": { "description": "spatialRelationships — the only field type that supports spatial filtering", "type": "string", "enum": [ "spatialRelationships" ] } } }, "type": { "type": "string", "enum": [ "SPATIAL" ] }, "value": { "description": "Spatial element ID(s). Omit for IS_EMPTY / IS_NOT_EMPTY.", "anyOf": [ { "description": "Single spatial element ID", "type": "string" }, { "description": "Multiple spatial element IDs", "type": "array", "items": { "type": "string" } } ] } } }, { "type": "object", "required": [ "clause", "field", "type" ], "properties": { "clause": { "description": "Text filter clause", "anyOf": [ { "type": "string", "enum": [ "TEXT_CONTAINS" ] }, { "type": "string", "enum": [ "TEXT_NOT_CONTAINS" ] }, { "type": "string", "enum": [ "TEXT_STARTS_WITH" ] }, { "type": "string", "enum": [ "TEXT_IS" ] }, { "type": "string", "enum": [ "TEXT_IS_NOT" ] }, { "type": "string", "enum": [ "TEXT_IS_EMPTY" ] }, { "type": "string", "enum": [ "TEXT_IS_NOT_EMPTY" ] } ] }, "field": { "type": "object", "required": [ "id", "type" ], "properties": { "categoryFilterId": { "type": "string" }, "id": { "description": "Layer field ID", "type": "string" }, "type": { "description": "Field types that support text filtering", "anyOf": [ { "type": "string", "enum": [ "text" ] }, { "type": "string", "enum": [ "area" ] }, { "type": "string", "enum": [ "barcode" ] }, { "type": "string", "enum": [ "email" ] }, { "type": "string", "enum": [ "phone" ] }, { "type": "string", "enum": [ "revitParam" ] }, { "type": "string", "enum": [ "LAYER_ELEMENT_NAME" ] }, { "type": "string", "enum": [ "LAYER_REVIT_PARAMETER" ] } ] } } }, "type": { "type": "string", "enum": [ "TEXT" ] }, "value": { "description": "Text value to match against. Omit for IS_EMPTY / IS_NOT_EMPTY.", "type": "string" } } } ], "type": "object" } } } }, "fieldDisplay": { "description": "Fields to display in the view element list", "type": "array", "items": { "type": "object", "required": [ "id", "type" ], "properties": { "id": { "description": "Layer field ID", "type": "string" }, "type": { "description": "Display type — use ARRAY for select/related/reference fields, BOOLEAN for toggle, DATE for date fields, NUMBER for number/phone, and TEXT for text/area/email/barcode/formula/person/createdBy/updatedBy fields", "anyOf": [ { "type": "string", "enum": [ "ARRAY" ] }, { "type": "string", "enum": [ "BOOLEAN" ] }, { "type": "string", "enum": [ "DATE" ] }, { "type": "string", "enum": [ "FILE" ] }, { "type": "string", "enum": [ "FORMULA_V2" ] }, { "type": "string", "enum": [ "LOOKUP" ] }, { "type": "string", "enum": [ "MODEL_VIEW" ] }, { "type": "string", "enum": [ "NUMBER" ] }, { "type": "string", "enum": [ "RANGE" ] }, { "type": "string", "enum": [ "SPATIAL_RELATIONSHIPS" ] }, { "type": "string", "enum": [ "TEXT" ] }, { "type": "string", "enum": [ "VERSION_HISTORY" ] } ] } } } }, "type": { "type": "string", "enum": [ "GALLERY" ] } } }, { "type": "object", "required": [ "name", "type" ], "properties": { "displayType": { "description": "Defines who has access to the view", "enum": [ "DEFAULT", "EVERYONE", "JUST_ME" ], "type": "string" }, "name": { "description": "View name", "type": "string" }, "sort": { "description": "Initial sort configuration for the view", "type": "array", "items": { "type": "object", "required": [ "direction", "field" ], "properties": { "direction": { "description": "Sort direction", "anyOf": [ { "type": "string", "enum": [ "asc" ] }, { "type": "string", "enum": [ "desc" ] } ] }, "field": { "type": "object", "required": [ "id", "type" ], "properties": { "id": { "description": "Layer field ID or default field key", "type": "string" }, "type": { "description": "Layer field type to sort by", "anyOf": [ { "type": "string", "enum": [ "area" ] }, { "type": "string", "enum": [ "createdat" ] }, { "type": "string", "enum": [ "createdby" ] }, { "type": "string", "enum": [ "date" ] }, { "type": "string", "enum": [ "elementNumber" ] }, { "type": "string", "enum": [ "file" ] }, { "type": "string", "enum": [ "formula" ] }, { "type": "string", "enum": [ "formulaV2" ] }, { "type": "string", "enum": [ "modelName" ] }, { "type": "string", "enum": [ "number" ] }, { "type": "string", "enum": [ "person" ] }, { "type": "string", "enum": [ "range" ] }, { "type": "string", "enum": [ "references" ] }, { "type": "string", "enum": [ "related" ] }, { "type": "string", "enum": [ "relatedV2" ] }, { "type": "string", "enum": [ "select" ] }, { "type": "string", "enum": [ "spatialRelationships" ] }, { "type": "string", "enum": [ "text" ] }, { "type": "string", "enum": [ "toggle" ] }, { "type": "string", "enum": [ "updatedat" ] }, { "type": "string", "enum": [ "updatedby" ] }, { "type": "string", "enum": [ "LAYER_ELEMENT_NAME" ] }, { "type": "string", "enum": [ "LAYER_REVIT_PARAMETER" ] } ] } } } } } }, "filterConfig": { "type": "object", "required": [ "condition", "filters" ], "properties": { "condition": { "description": "Logical operator across all filters — 'AND' requires every filter to match, 'OR' requires at least one", "anyOf": [ { "type": "string", "enum": [ "AND" ] }, { "type": "string", "enum": [ "OR" ] } ] }, "filters": { "description": "Array of individual filter conditions", "type": "array", "items": { "oneOf": [ { "type": "object", "required": [ "clause", "field", "type" ], "properties": { "clause": { "description": "Array filter clause", "anyOf": [ { "type": "string", "enum": [ "ARRAY_CONTAINS" ] }, { "type": "string", "enum": [ "ARRAY_NOT_CONTAINS" ] }, { "type": "string", "enum": [ "ARRAY_IS" ] }, { "type": "string", "enum": [ "ARRAY_IS_NOT" ] }, { "type": "string", "enum": [ "ARRAY_IS_EMPTY" ] }, { "type": "string", "enum": [ "ARRAY_IS_NOT_EMPTY" ] } ] }, "field": { "type": "object", "required": [ "id", "type" ], "properties": { "categoryFilterId": { "type": "string" }, "id": { "description": "Layer field ID", "type": "string" }, "type": { "description": "Field types that support array filtering: select (option IDs), person/user (user refs), related (document refs), relatedV2 (element refs)", "anyOf": [ { "type": "string", "enum": [ "select" ] }, { "type": "string", "enum": [ "person" ] }, { "type": "string", "enum": [ "createdby" ] }, { "type": "string", "enum": [ "updatedby" ] }, { "type": "string", "enum": [ "related" ] }, { "type": "string", "enum": [ "relatedV2" ] } ] } } }, "type": { "type": "string", "enum": [ "ARRAY" ] }, "value": { "description": "Array of option IDs (select), user refs (person/user), or full element ref paths for related/relatedV2 fields — MUST be \"projects/{projectId}/elements/{elementId}\", never bare element IDs. Omit for IS_EMPTY / IS_NOT_EMPTY.", "type": "array", "items": { "type": "string" } } } }, { "type": "object", "required": [ "clause", "field", "type" ], "properties": { "clause": { "description": "Boolean filter clause", "anyOf": [ { "type": "string", "enum": [ "BOOL_IS" ] }, { "type": "string", "enum": [ "BOOL_IS_NOT" ] } ] }, "field": { "type": "object", "required": [ "id", "type" ], "properties": { "categoryFilterId": { "type": "string" }, "id": { "description": "Layer field ID", "type": "string" }, "type": { "description": "toggle — the only field type that supports boolean filtering", "type": "string", "enum": [ "toggle" ] } } }, "type": { "type": "string", "enum": [ "BOOLEAN" ] }, "value": { "description": "Boolean value to match", "type": "boolean" } } }, { "type": "object", "required": [ "clause", "field", "type" ], "properties": { "clause": { "description": "Date filter clause", "anyOf": [ { "type": "string", "enum": [ "DATE_IS" ] }, { "type": "string", "enum": [ "DATE_IS_BEFORE" ] }, { "type": "string", "enum": [ "DATE_IS_AFTER" ] }, { "type": "string", "enum": [ "DATE_IS_EMPTY" ] }, { "type": "string", "enum": [ "DATE_IS_NOT_EMPTY" ] }, { "type": "string", "enum": [ "DATE_IS_WITHIN" ] } ] }, "field": { "type": "object", "required": [ "id", "type" ], "properties": { "categoryFilterId": { "type": "string" }, "id": { "description": "Layer field ID", "type": "string" }, "type": { "description": "Field types that support date filtering", "anyOf": [ { "type": "string", "enum": [ "date" ] }, { "type": "string", "enum": [ "createdat" ] }, { "type": "string", "enum": [ "updatedat" ] } ] } } }, "type": { "type": "string", "enum": [ "DATE" ] }, "value": { "description": "Absolute date-time string or relative-date config (DATE_IS_WITHIN). Omit for IS_EMPTY / IS_NOT_EMPTY.", "anyOf": [ { "description": "ISO 8601 date-time string — use with DATE_IS, DATE_IS_BEFORE, DATE_IS_AFTER", "format": "date-time", "type": "string" }, { "description": "Relative-date value used with the DATE_IS_WITHIN clause", "type": "object", "required": [ "direction", "interval" ], "properties": { "direction": { "description": "Temporal direction — 'past': look back, 'next': look forward, 'this': current period", "anyOf": [ { "type": "string", "enum": [ "next" ] }, { "type": "string", "enum": [ "past" ] }, { "type": "string", "enum": [ "this" ] } ] }, "interval": { "description": "Calendar interval unit", "anyOf": [ { "type": "string", "enum": [ "days" ] }, { "type": "string", "enum": [ "months" ] }, { "type": "string", "enum": [ "weeks" ] }, { "type": "string", "enum": [ "years" ] } ] }, "intervalValue": { "description": "Number of intervals. Omit when direction is 'this'.", "type": "number" } } } ] } } }, { "type": "object", "required": [ "clause", "field", "type" ], "properties": { "clause": { "description": "Number filter clause", "anyOf": [ { "type": "string", "enum": [ "==" ] }, { "type": "string", "enum": [ "!=" ] }, { "type": "string", "enum": [ "<" ] }, { "type": "string", "enum": [ "<=" ] }, { "type": "string", "enum": [ ">" ] }, { "type": "string", "enum": [ ">=" ] }, { "type": "string", "enum": [ "NUMBER_IS_EMPTY" ] }, { "type": "string", "enum": [ "NUMBER_IS_NOT_EMPTY" ] } ] }, "field": { "type": "object", "required": [ "id", "type" ], "properties": { "categoryFilterId": { "type": "string" }, "id": { "description": "Layer field ID", "type": "string" }, "type": { "description": "Field types that support number filtering", "anyOf": [ { "type": "string", "enum": [ "number" ] }, { "type": "string", "enum": [ "range" ] }, { "type": "string", "enum": [ "elementNumber" ] } ] } } }, "type": { "type": "string", "enum": [ "NUMBER" ] }, "value": { "description": "Numeric value to compare against. Omit for IS_EMPTY / IS_NOT_EMPTY.", "type": "number" } } }, { "type": "object", "required": [ "clause", "field", "type" ], "properties": { "clause": { "description": "Reference filter clause — presence-only checks; no value field required", "anyOf": [ { "type": "string", "enum": [ "REFERENCE_IS_EMPTY" ] }, { "type": "string", "enum": [ "REFERENCE_IS_NOT_EMPTY" ] } ] }, "field": { "type": "object", "required": [ "id", "type" ], "properties": { "categoryFilterId": { "type": "string" }, "id": { "description": "Layer field ID", "type": "string" }, "type": { "description": "Field types that support reference filtering", "type": "string", "enum": [ "references" ] } } }, "type": { "type": "string", "enum": [ "REFERENCE" ] } } }, { "type": "object", "required": [ "clause", "field", "type" ], "properties": { "clause": { "description": "Spatial filter clause", "anyOf": [ { "type": "string", "enum": [ "SPATIAL_CONTAINS" ] }, { "type": "string", "enum": [ "SPATIAL_NOT_CONTAINS" ] }, { "type": "string", "enum": [ "SPATIAL_IS" ] }, { "type": "string", "enum": [ "SPATIAL_IS_NOT" ] }, { "type": "string", "enum": [ "SPATIAL_IS_EMPTY" ] }, { "type": "string", "enum": [ "SPATIAL_IS_NOT_EMPTY" ] } ] }, "field": { "type": "object", "required": [ "id", "type" ], "properties": { "categoryFilterId": { "type": "string" }, "id": { "description": "Layer field ID", "type": "string" }, "type": { "description": "spatialRelationships — the only field type that supports spatial filtering", "type": "string", "enum": [ "spatialRelationships" ] } } }, "type": { "type": "string", "enum": [ "SPATIAL" ] }, "value": { "description": "Spatial element ID(s). Omit for IS_EMPTY / IS_NOT_EMPTY.", "anyOf": [ { "description": "Single spatial element ID", "type": "string" }, { "description": "Multiple spatial element IDs", "type": "array", "items": { "type": "string" } } ] } } }, { "type": "object", "required": [ "clause", "field", "type" ], "properties": { "clause": { "description": "Text filter clause", "anyOf": [ { "type": "string", "enum": [ "TEXT_CONTAINS" ] }, { "type": "string", "enum": [ "TEXT_NOT_CONTAINS" ] }, { "type": "string", "enum": [ "TEXT_STARTS_WITH" ] }, { "type": "string", "enum": [ "TEXT_IS" ] }, { "type": "string", "enum": [ "TEXT_IS_NOT" ] }, { "type": "string", "enum": [ "TEXT_IS_EMPTY" ] }, { "type": "string", "enum": [ "TEXT_IS_NOT_EMPTY" ] } ] }, "field": { "type": "object", "required": [ "id", "type" ], "properties": { "categoryFilterId": { "type": "string" }, "id": { "description": "Layer field ID", "type": "string" }, "type": { "description": "Field types that support text filtering", "anyOf": [ { "type": "string", "enum": [ "text" ] }, { "type": "string", "enum": [ "area" ] }, { "type": "string", "enum": [ "barcode" ] }, { "type": "string", "enum": [ "email" ] }, { "type": "string", "enum": [ "phone" ] }, { "type": "string", "enum": [ "revitParam" ] }, { "type": "string", "enum": [ "LAYER_ELEMENT_NAME" ] }, { "type": "string", "enum": [ "LAYER_REVIT_PARAMETER" ] } ] } } }, "type": { "type": "string", "enum": [ "TEXT" ] }, "value": { "description": "Text value to match against. Omit for IS_EMPTY / IS_NOT_EMPTY.", "type": "string" } } } ], "type": "object" } } } }, "type": { "type": "string", "enum": [ "MODEL" ] } } }, { "type": "object", "required": [ "name", "type" ], "properties": { "displayType": { "description": "Defines who has access to the view", "enum": [ "DEFAULT", "EVERYONE", "JUST_ME" ], "type": "string" }, "name": { "description": "View name", "type": "string" }, "sort": { "description": "Initial sort configuration for the view", "type": "array", "items": { "type": "object", "required": [ "direction", "field" ], "properties": { "direction": { "description": "Sort direction", "anyOf": [ { "type": "string", "enum": [ "asc" ] }, { "type": "string", "enum": [ "desc" ] } ] }, "field": { "type": "object", "required": [ "id", "type" ], "properties": { "id": { "description": "Layer field ID or default field key", "type": "string" }, "type": { "description": "Layer field type to sort by", "anyOf": [ { "type": "string", "enum": [ "area" ] }, { "type": "string", "enum": [ "createdat" ] }, { "type": "string", "enum": [ "createdby" ] }, { "type": "string", "enum": [ "date" ] }, { "type": "string", "enum": [ "elementNumber" ] }, { "type": "string", "enum": [ "file" ] }, { "type": "string", "enum": [ "formula" ] }, { "type": "string", "enum": [ "formulaV2" ] }, { "type": "string", "enum": [ "modelName" ] }, { "type": "string", "enum": [ "number" ] }, { "type": "string", "enum": [ "person" ] }, { "type": "string", "enum": [ "range" ] }, { "type": "string", "enum": [ "references" ] }, { "type": "string", "enum": [ "related" ] }, { "type": "string", "enum": [ "relatedV2" ] }, { "type": "string", "enum": [ "select" ] }, { "type": "string", "enum": [ "spatialRelationships" ] }, { "type": "string", "enum": [ "text" ] }, { "type": "string", "enum": [ "toggle" ] }, { "type": "string", "enum": [ "updatedat" ] }, { "type": "string", "enum": [ "updatedby" ] }, { "type": "string", "enum": [ "LAYER_ELEMENT_NAME" ] }, { "type": "string", "enum": [ "LAYER_REVIT_PARAMETER" ] } ] } } } } } }, "filterConfig": { "type": "object", "required": [ "condition", "filters" ], "properties": { "condition": { "description": "Logical operator across all filters — 'AND' requires every filter to match, 'OR' requires at least one", "anyOf": [ { "type": "string", "enum": [ "AND" ] }, { "type": "string", "enum": [ "OR" ] } ] }, "filters": { "description": "Array of individual filter conditions", "type": "array", "items": { "oneOf": [ { "type": "object", "required": [ "clause", "field", "type" ], "properties": { "clause": { "description": "Array filter clause", "anyOf": [ { "type": "string", "enum": [ "ARRAY_CONTAINS" ] }, { "type": "string", "enum": [ "ARRAY_NOT_CONTAINS" ] }, { "type": "string", "enum": [ "ARRAY_IS" ] }, { "type": "string", "enum": [ "ARRAY_IS_NOT" ] }, { "type": "string", "enum": [ "ARRAY_IS_EMPTY" ] }, { "type": "string", "enum": [ "ARRAY_IS_NOT_EMPTY" ] } ] }, "field": { "type": "object", "required": [ "id", "type" ], "properties": { "categoryFilterId": { "type": "string" }, "id": { "description": "Layer field ID", "type": "string" }, "type": { "description": "Field types that support array filtering: select (option IDs), person/user (user refs), related (document refs), relatedV2 (element refs)", "anyOf": [ { "type": "string", "enum": [ "select" ] }, { "type": "string", "enum": [ "person" ] }, { "type": "string", "enum": [ "createdby" ] }, { "type": "string", "enum": [ "updatedby" ] }, { "type": "string", "enum": [ "related" ] }, { "type": "string", "enum": [ "relatedV2" ] } ] } } }, "type": { "type": "string", "enum": [ "ARRAY" ] }, "value": { "description": "Array of option IDs (select), user refs (person/user), or full element ref paths for related/relatedV2 fields — MUST be \"projects/{projectId}/elements/{elementId}\", never bare element IDs. Omit for IS_EMPTY / IS_NOT_EMPTY.", "type": "array", "items": { "type": "string" } } } }, { "type": "object", "required": [ "clause", "field", "type" ], "properties": { "clause": { "description": "Boolean filter clause", "anyOf": [ { "type": "string", "enum": [ "BOOL_IS" ] }, { "type": "string", "enum": [ "BOOL_IS_NOT" ] } ] }, "field": { "type": "object", "required": [ "id", "type" ], "properties": { "categoryFilterId": { "type": "string" }, "id": { "description": "Layer field ID", "type": "string" }, "type": { "description": "toggle — the only field type that supports boolean filtering", "type": "string", "enum": [ "toggle" ] } } }, "type": { "type": "string", "enum": [ "BOOLEAN" ] }, "value": { "description": "Boolean value to match", "type": "boolean" } } }, { "type": "object", "required": [ "clause", "field", "type" ], "properties": { "clause": { "description": "Date filter clause", "anyOf": [ { "type": "string", "enum": [ "DATE_IS" ] }, { "type": "string", "enum": [ "DATE_IS_BEFORE" ] }, { "type": "string", "enum": [ "DATE_IS_AFTER" ] }, { "type": "string", "enum": [ "DATE_IS_EMPTY" ] }, { "type": "string", "enum": [ "DATE_IS_NOT_EMPTY" ] }, { "type": "string", "enum": [ "DATE_IS_WITHIN" ] } ] }, "field": { "type": "object", "required": [ "id", "type" ], "properties": { "categoryFilterId": { "type": "string" }, "id": { "description": "Layer field ID", "type": "string" }, "type": { "description": "Field types that support date filtering", "anyOf": [ { "type": "string", "enum": [ "date" ] }, { "type": "string", "enum": [ "createdat" ] }, { "type": "string", "enum": [ "updatedat" ] } ] } } }, "type": { "type": "string", "enum": [ "DATE" ] }, "value": { "description": "Absolute date-time string or relative-date config (DATE_IS_WITHIN). Omit for IS_EMPTY / IS_NOT_EMPTY.", "anyOf": [ { "description": "ISO 8601 date-time string — use with DATE_IS, DATE_IS_BEFORE, DATE_IS_AFTER", "format": "date-time", "type": "string" }, { "description": "Relative-date value used with the DATE_IS_WITHIN clause", "type": "object", "required": [ "direction", "interval" ], "properties": { "direction": { "description": "Temporal direction — 'past': look back, 'next': look forward, 'this': current period", "anyOf": [ { "type": "string", "enum": [ "next" ] }, { "type": "string", "enum": [ "past" ] }, { "type": "string", "enum": [ "this" ] } ] }, "interval": { "description": "Calendar interval unit", "anyOf": [ { "type": "string", "enum": [ "days" ] }, { "type": "string", "enum": [ "months" ] }, { "type": "string", "enum": [ "weeks" ] }, { "type": "string", "enum": [ "years" ] } ] }, "intervalValue": { "description": "Number of intervals. Omit when direction is 'this'.", "type": "number" } } } ] } } }, { "type": "object", "required": [ "clause", "field", "type" ], "properties": { "clause": { "description": "Number filter clause", "anyOf": [ { "type": "string", "enum": [ "==" ] }, { "type": "string", "enum": [ "!=" ] }, { "type": "string", "enum": [ "<" ] }, { "type": "string", "enum": [ "<=" ] }, { "type": "string", "enum": [ ">" ] }, { "type": "string", "enum": [ ">=" ] }, { "type": "string", "enum": [ "NUMBER_IS_EMPTY" ] }, { "type": "string", "enum": [ "NUMBER_IS_NOT_EMPTY" ] } ] }, "field": { "type": "object", "required": [ "id", "type" ], "properties": { "categoryFilterId": { "type": "string" }, "id": { "description": "Layer field ID", "type": "string" }, "type": { "description": "Field types that support number filtering", "anyOf": [ { "type": "string", "enum": [ "number" ] }, { "type": "string", "enum": [ "range" ] }, { "type": "string", "enum": [ "elementNumber" ] } ] } } }, "type": { "type": "string", "enum": [ "NUMBER" ] }, "value": { "description": "Numeric value to compare against. Omit for IS_EMPTY / IS_NOT_EMPTY.", "type": "number" } } }, { "type": "object", "required": [ "clause", "field", "type" ], "properties": { "clause": { "description": "Reference filter clause — presence-only checks; no value field required", "anyOf": [ { "type": "string", "enum": [ "REFERENCE_IS_EMPTY" ] }, { "type": "string", "enum": [ "REFERENCE_IS_NOT_EMPTY" ] } ] }, "field": { "type": "object", "required": [ "id", "type" ], "properties": { "categoryFilterId": { "type": "string" }, "id": { "description": "Layer field ID", "type": "string" }, "type": { "description": "Field types that support reference filtering", "type": "string", "enum": [ "references" ] } } }, "type": { "type": "string", "enum": [ "REFERENCE" ] } } }, { "type": "object", "required": [ "clause", "field", "type" ], "properties": { "clause": { "description": "Spatial filter clause", "anyOf": [ { "type": "string", "enum": [ "SPATIAL_CONTAINS" ] }, { "type": "string", "enum": [ "SPATIAL_NOT_CONTAINS" ] }, { "type": "string", "enum": [ "SPATIAL_IS" ] }, { "type": "string", "enum": [ "SPATIAL_IS_NOT" ] }, { "type": "string", "enum": [ "SPATIAL_IS_EMPTY" ] }, { "type": "string", "enum": [ "SPATIAL_IS_NOT_EMPTY" ] } ] }, "field": { "type": "object", "required": [ "id", "type" ], "properties": { "categoryFilterId": { "type": "string" }, "id": { "description": "Layer field ID", "type": "string" }, "type": { "description": "spatialRelationships — the only field type that supports spatial filtering", "type": "string", "enum": [ "spatialRelationships" ] } } }, "type": { "type": "string", "enum": [ "SPATIAL" ] }, "value": { "description": "Spatial element ID(s). Omit for IS_EMPTY / IS_NOT_EMPTY.", "anyOf": [ { "description": "Single spatial element ID", "type": "string" }, { "description": "Multiple spatial element IDs", "type": "array", "items": { "type": "string" } } ] } } }, { "type": "object", "required": [ "clause", "field", "type" ], "properties": { "clause": { "description": "Text filter clause", "anyOf": [ { "type": "string", "enum": [ "TEXT_CONTAINS" ] }, { "type": "string", "enum": [ "TEXT_NOT_CONTAINS" ] }, { "type": "string", "enum": [ "TEXT_STARTS_WITH" ] }, { "type": "string", "enum": [ "TEXT_IS" ] }, { "type": "string", "enum": [ "TEXT_IS_NOT" ] }, { "type": "string", "enum": [ "TEXT_IS_EMPTY" ] }, { "type": "string", "enum": [ "TEXT_IS_NOT_EMPTY" ] } ] }, "field": { "type": "object", "required": [ "id", "type" ], "properties": { "categoryFilterId": { "type": "string" }, "id": { "description": "Layer field ID", "type": "string" }, "type": { "description": "Field types that support text filtering", "anyOf": [ { "type": "string", "enum": [ "text" ] }, { "type": "string", "enum": [ "area" ] }, { "type": "string", "enum": [ "barcode" ] }, { "type": "string", "enum": [ "email" ] }, { "type": "string", "enum": [ "phone" ] }, { "type": "string", "enum": [ "revitParam" ] }, { "type": "string", "enum": [ "LAYER_ELEMENT_NAME" ] }, { "type": "string", "enum": [ "LAYER_REVIT_PARAMETER" ] } ] } } }, "type": { "type": "string", "enum": [ "TEXT" ] }, "value": { "description": "Text value to match against. Omit for IS_EMPTY / IS_NOT_EMPTY.", "type": "string" } } } ], "type": "object" } } } }, "fieldDisplay": { "description": "Fields to display in the view element list", "type": "array", "items": { "type": "object", "required": [ "id", "type" ], "properties": { "id": { "description": "Layer field ID", "type": "string" }, "type": { "description": "Display type — use ARRAY for select/related/reference fields, BOOLEAN for toggle, DATE for date fields, NUMBER for number/phone, and TEXT for text/area/email/barcode/formula/person/createdBy/updatedBy fields", "anyOf": [ { "type": "string", "enum": [ "ARRAY" ] }, { "type": "string", "enum": [ "BOOLEAN" ] }, { "type": "string", "enum": [ "DATE" ] }, { "type": "string", "enum": [ "FILE" ] }, { "type": "string", "enum": [ "FORMULA_V2" ] }, { "type": "string", "enum": [ "LOOKUP" ] }, { "type": "string", "enum": [ "MODEL_VIEW" ] }, { "type": "string", "enum": [ "NUMBER" ] }, { "type": "string", "enum": [ "RANGE" ] }, { "type": "string", "enum": [ "SPATIAL_RELATIONSHIPS" ] }, { "type": "string", "enum": [ "TEXT" ] }, { "type": "string", "enum": [ "VERSION_HISTORY" ] } ] } } } }, "type": { "type": "string", "enum": [ "TABLE" ] } } } ], "type": "object" }, "categoryId": { "description": "Category ID", "type": "string" }, "tool": { "type": "string", "enum": [ "createCategoryView" ] } } }, { "type": "object", "required": [ "body", "categoryId", "tool", "viewId" ], "properties": { "body": { "type": "object", "properties": { "fieldDisplay": { "description": "Updated field display configuration (TABLE and GALLERY views only; not supported for FORM views)", "type": "array", "items": { "type": "object", "required": [ "id", "type" ], "properties": { "id": { "description": "Layer field ID", "type": "string" }, "type": { "description": "Display type — use ARRAY for select/related/reference fields, BOOLEAN for toggle, DATE for date fields, NUMBER for number/phone, and TEXT for text/area/email/barcode/formula/person/createdBy/updatedBy fields", "anyOf": [ { "type": "string", "enum": [ "ARRAY" ] }, { "type": "string", "enum": [ "BOOLEAN" ] }, { "type": "string", "enum": [ "DATE" ] }, { "type": "string", "enum": [ "FILE" ] }, { "type": "string", "enum": [ "FORMULA_V2" ] }, { "type": "string", "enum": [ "LOOKUP" ] }, { "type": "string", "enum": [ "MODEL_VIEW" ] }, { "type": "string", "enum": [ "NUMBER" ] }, { "type": "string", "enum": [ "RANGE" ] }, { "type": "string", "enum": [ "SPATIAL_RELATIONSHIPS" ] }, { "type": "string", "enum": [ "TEXT" ] }, { "type": "string", "enum": [ "VERSION_HISTORY" ] } ] } } } }, "filterConfig": { "type": "object", "required": [ "condition", "filters" ], "properties": { "condition": { "description": "Logical operator across all filters — 'AND' requires every filter to match, 'OR' requires at least one", "anyOf": [ { "type": "string", "enum": [ "AND" ] }, { "type": "string", "enum": [ "OR" ] } ] }, "filters": { "description": "Array of individual filter conditions", "type": "array", "items": { "oneOf": [ { "type": "object", "required": [ "clause", "field", "type" ], "properties": { "clause": { "description": "Array filter clause", "anyOf": [ { "type": "string", "enum": [ "ARRAY_CONTAINS" ] }, { "type": "string", "enum": [ "ARRAY_NOT_CONTAINS" ] }, { "type": "string", "enum": [ "ARRAY_IS" ] }, { "type": "string", "enum": [ "ARRAY_IS_NOT" ] }, { "type": "string", "enum": [ "ARRAY_IS_EMPTY" ] }, { "type": "string", "enum": [ "ARRAY_IS_NOT_EMPTY" ] } ] }, "field": { "type": "object", "required": [ "id", "type" ], "properties": { "categoryFilterId": { "type": "string" }, "id": { "description": "Layer field ID", "type": "string" }, "type": { "description": "Field types that support array filtering: select (option IDs), person/user (user refs), related (document refs), relatedV2 (element refs)", "anyOf": [ { "type": "string", "enum": [ "select" ] }, { "type": "string", "enum": [ "person" ] }, { "type": "string", "enum": [ "createdby" ] }, { "type": "string", "enum": [ "updatedby" ] }, { "type": "string", "enum": [ "related" ] }, { "type": "string", "enum": [ "relatedV2" ] } ] } } }, "type": { "type": "string", "enum": [ "ARRAY" ] }, "value": { "description": "Array of option IDs (select), user refs (person/user), or full element ref paths for related/relatedV2 fields — MUST be \"projects/{projectId}/elements/{elementId}\", never bare element IDs. Omit for IS_EMPTY / IS_NOT_EMPTY.", "type": "array", "items": { "type": "string" } } } }, { "type": "object", "required": [ "clause", "field", "type" ], "properties": { "clause": { "description": "Boolean filter clause", "anyOf": [ { "type": "string", "enum": [ "BOOL_IS" ] }, { "type": "string", "enum": [ "BOOL_IS_NOT" ] } ] }, "field": { "type": "object", "required": [ "id", "type" ], "properties": { "categoryFilterId": { "type": "string" }, "id": { "description": "Layer field ID", "type": "string" }, "type": { "description": "toggle — the only field type that supports boolean filtering", "type": "string", "enum": [ "toggle" ] } } }, "type": { "type": "string", "enum": [ "BOOLEAN" ] }, "value": { "description": "Boolean value to match", "type": "boolean" } } }, { "type": "object", "required": [ "clause", "field", "type" ], "properties": { "clause": { "description": "Date filter clause", "anyOf": [ { "type": "string", "enum": [ "DATE_IS" ] }, { "type": "string", "enum": [ "DATE_IS_BEFORE" ] }, { "type": "string", "enum": [ "DATE_IS_AFTER" ] }, { "type": "string", "enum": [ "DATE_IS_EMPTY" ] }, { "type": "string", "enum": [ "DATE_IS_NOT_EMPTY" ] }, { "type": "string", "enum": [ "DATE_IS_WITHIN" ] } ] }, "field": { "type": "object", "required": [ "id", "type" ], "properties": { "categoryFilterId": { "type": "string" }, "id": { "description": "Layer field ID", "type": "string" }, "type": { "description": "Field types that support date filtering", "anyOf": [ { "type": "string", "enum": [ "date" ] }, { "type": "string", "enum": [ "createdat" ] }, { "type": "string", "enum": [ "updatedat" ] } ] } } }, "type": { "type": "string", "enum": [ "DATE" ] }, "value": { "description": "Absolute date-time string or relative-date config (DATE_IS_WITHIN). Omit for IS_EMPTY / IS_NOT_EMPTY.", "anyOf": [ { "description": "ISO 8601 date-time string — use with DATE_IS, DATE_IS_BEFORE, DATE_IS_AFTER", "format": "date-time", "type": "string" }, { "description": "Relative-date value used with the DATE_IS_WITHIN clause", "type": "object", "required": [ "direction", "interval" ], "properties": { "direction": { "description": "Temporal direction — 'past': look back, 'next': look forward, 'this': current period", "anyOf": [ { "type": "string", "enum": [ "next" ] }, { "type": "string", "enum": [ "past" ] }, { "type": "string", "enum": [ "this" ] } ] }, "interval": { "description": "Calendar interval unit", "anyOf": [ { "type": "string", "enum": [ "days" ] }, { "type": "string", "enum": [ "months" ] }, { "type": "string", "enum": [ "weeks" ] }, { "type": "string", "enum": [ "years" ] } ] }, "intervalValue": { "description": "Number of intervals. Omit when direction is 'this'.", "type": "number" } } } ] } } }, { "type": "object", "required": [ "clause", "field", "type" ], "properties": { "clause": { "description": "Number filter clause", "anyOf": [ { "type": "string", "enum": [ "==" ] }, { "type": "string", "enum": [ "!=" ] }, { "type": "string", "enum": [ "<" ] }, { "type": "string", "enum": [ "<=" ] }, { "type": "string", "enum": [ ">" ] }, { "type": "string", "enum": [ ">=" ] }, { "type": "string", "enum": [ "NUMBER_IS_EMPTY" ] }, { "type": "string", "enum": [ "NUMBER_IS_NOT_EMPTY" ] } ] }, "field": { "type": "object", "required": [ "id", "type" ], "properties": { "categoryFilterId": { "type": "string" }, "id": { "description": "Layer field ID", "type": "string" }, "type": { "description": "Field types that support number filtering", "anyOf": [ { "type": "string", "enum": [ "number" ] }, { "type": "string", "enum": [ "range" ] }, { "type": "string", "enum": [ "elementNumber" ] } ] } } }, "type": { "type": "string", "enum": [ "NUMBER" ] }, "value": { "description": "Numeric value to compare against. Omit for IS_EMPTY / IS_NOT_EMPTY.", "type": "number" } } }, { "type": "object", "required": [ "clause", "field", "type" ], "properties": { "clause": { "description": "Reference filter clause — presence-only checks; no value field required", "anyOf": [ { "type": "string", "enum": [ "REFERENCE_IS_EMPTY" ] }, { "type": "string", "enum": [ "REFERENCE_IS_NOT_EMPTY" ] } ] }, "field": { "type": "object", "required": [ "id", "type" ], "properties": { "categoryFilterId": { "type": "string" }, "id": { "description": "Layer field ID", "type": "string" }, "type": { "description": "Field types that support reference filtering", "type": "string", "enum": [ "references" ] } } }, "type": { "type": "string", "enum": [ "REFERENCE" ] } } }, { "type": "object", "required": [ "clause", "field", "type" ], "properties": { "clause": { "description": "Spatial filter clause", "anyOf": [ { "type": "string", "enum": [ "SPATIAL_CONTAINS" ] }, { "type": "string", "enum": [ "SPATIAL_NOT_CONTAINS" ] }, { "type": "string", "enum": [ "SPATIAL_IS" ] }, { "type": "string", "enum": [ "SPATIAL_IS_NOT" ] }, { "type": "string", "enum": [ "SPATIAL_IS_EMPTY" ] }, { "type": "string", "enum": [ "SPATIAL_IS_NOT_EMPTY" ] } ] }, "field": { "type": "object", "required": [ "id", "type" ], "properties": { "categoryFilterId": { "type": "string" }, "id": { "description": "Layer field ID", "type": "string" }, "type": { "description": "spatialRelationships — the only field type that supports spatial filtering", "type": "string", "enum": [ "spatialRelationships" ] } } }, "type": { "type": "string", "enum": [ "SPATIAL" ] }, "value": { "description": "Spatial element ID(s). Omit for IS_EMPTY / IS_NOT_EMPTY.", "anyOf": [ { "description": "Single spatial element ID", "type": "string" }, { "description": "Multiple spatial element IDs", "type": "array", "items": { "type": "string" } } ] } } }, { "type": "object", "required": [ "clause", "field", "type" ], "properties": { "clause": { "description": "Text filter clause", "anyOf": [ { "type": "string", "enum": [ "TEXT_CONTAINS" ] }, { "type": "string", "enum": [ "TEXT_NOT_CONTAINS" ] }, { "type": "string", "enum": [ "TEXT_STARTS_WITH" ] }, { "type": "string", "enum": [ "TEXT_IS" ] }, { "type": "string", "enum": [ "TEXT_IS_NOT" ] }, { "type": "string", "enum": [ "TEXT_IS_EMPTY" ] }, { "type": "string", "enum": [ "TEXT_IS_NOT_EMPTY" ] } ] }, "field": { "type": "object", "required": [ "id", "type" ], "properties": { "categoryFilterId": { "type": "string" }, "id": { "description": "Layer field ID", "type": "string" }, "type": { "description": "Field types that support text filtering", "anyOf": [ { "type": "string", "enum": [ "text" ] }, { "type": "string", "enum": [ "area" ] }, { "type": "string", "enum": [ "barcode" ] }, { "type": "string", "enum": [ "email" ] }, { "type": "string", "enum": [ "phone" ] }, { "type": "string", "enum": [ "revitParam" ] }, { "type": "string", "enum": [ "LAYER_ELEMENT_NAME" ] }, { "type": "string", "enum": [ "LAYER_REVIT_PARAMETER" ] } ] } } }, "type": { "type": "string", "enum": [ "TEXT" ] }, "value": { "description": "Text value to match against. Omit for IS_EMPTY / IS_NOT_EMPTY.", "type": "string" } } } ], "type": "object" } } } }, "name": { "description": "Updated view name", "type": "string" }, "sort": { "description": "Updated sort configuration", "type": "array", "items": { "type": "object", "required": [ "direction", "field" ], "properties": { "direction": { "description": "Sort direction", "anyOf": [ { "type": "string", "enum": [ "asc" ] }, { "type": "string", "enum": [ "desc" ] } ] }, "field": { "type": "object", "required": [ "id", "type" ], "properties": { "id": { "description": "Layer field ID or default field key", "type": "string" }, "type": { "description": "Layer field type to sort by", "anyOf": [ { "type": "string", "enum": [ "area" ] }, { "type": "string", "enum": [ "createdat" ] }, { "type": "string", "enum": [ "createdby" ] }, { "type": "string", "enum": [ "date" ] }, { "type": "string", "enum": [ "elementNumber" ] }, { "type": "string", "enum": [ "file" ] }, { "type": "string", "enum": [ "formula" ] }, { "type": "string", "enum": [ "formulaV2" ] }, { "type": "string", "enum": [ "modelName" ] }, { "type": "string", "enum": [ "number" ] }, { "type": "string", "enum": [ "person" ] }, { "type": "string", "enum": [ "range" ] }, { "type": "string", "enum": [ "references" ] }, { "type": "string", "enum": [ "related" ] }, { "type": "string", "enum": [ "relatedV2" ] }, { "type": "string", "enum": [ "select" ] }, { "type": "string", "enum": [ "spatialRelationships" ] }, { "type": "string", "enum": [ "text" ] }, { "type": "string", "enum": [ "toggle" ] }, { "type": "string", "enum": [ "updatedat" ] }, { "type": "string", "enum": [ "updatedby" ] }, { "type": "string", "enum": [ "LAYER_ELEMENT_NAME" ] }, { "type": "string", "enum": [ "LAYER_REVIT_PARAMETER" ] } ] } } } } } } } }, "categoryId": { "description": "Category ID", "type": "string" }, "tool": { "type": "string", "enum": [ "updateCategoryView" ] }, "viewId": { "description": "Category view ID", "type": "string" } } }, { "type": "object", "required": [ "body", "tool" ], "properties": { "body": { "type": "object", "oneOf": [ { "additionalProperties": false, "title": "Text Area Field", "type": "object", "required": [ "type", "category", "name" ], "properties": { "placeholder": { "description": "The placeholder value for the field, displayed in the app", "maxLength": 250, "default": "", "type": "string" }, "textAreaSize": { "description": "The size that the text area appears in the app", "enum": [ "LARGE", "MEDIUM", "SMALL" ], "default": "MEDIUM", "type": "string" }, "type": { "type": "string", "enum": [ "area" ] }, "category": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" } } }, "color": { "description": "The color of the field in the app", "enum": [ "lime", "success", "emerald", "teal", "cyan", "sky", "blue", "accent", "violet", "fuchsia", "pink", "rose", "warn", "orange", "amber", "danger", "neutral", "stone", "zinc", "primary" ], "nullable": true, "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" } } }, { "additionalProperties": false, "title": "Barcode Field", "type": "object", "required": [ "type", "category", "name" ], "properties": { "type": { "type": "string", "enum": [ "barcode" ] }, "category": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" } } }, "color": { "description": "The color of the field in the app", "enum": [ "lime", "success", "emerald", "teal", "cyan", "sky", "blue", "accent", "violet", "fuchsia", "pink", "rose", "warn", "orange", "amber", "danger", "neutral", "stone", "zinc", "primary" ], "nullable": true, "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" } } }, { "additionalProperties": false, "title": "Created At Field", "type": "object", "required": [ "type", "category", "name" ], "properties": { "type": { "type": "string", "enum": [ "createdat" ] }, "category": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" } } }, "color": { "description": "The color of the field in the app", "enum": [ "lime", "success", "emerald", "teal", "cyan", "sky", "blue", "accent", "violet", "fuchsia", "pink", "rose", "warn", "orange", "amber", "danger", "neutral", "stone", "zinc", "primary" ], "nullable": true, "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" } } }, { "additionalProperties": false, "title": "Created By Field", "type": "object", "required": [ "type", "category", "name" ], "properties": { "type": { "type": "string", "enum": [ "createdby" ] }, "category": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" } } }, "color": { "description": "The color of the field in the app", "enum": [ "lime", "success", "emerald", "teal", "cyan", "sky", "blue", "accent", "violet", "fuchsia", "pink", "rose", "warn", "orange", "amber", "danger", "neutral", "stone", "zinc", "primary" ], "nullable": true, "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" } } }, { "additionalProperties": false, "title": "Date Field", "type": "object", "required": [ "type", "category", "name" ], "properties": { "type": { "type": "string", "enum": [ "date" ] }, "category": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" } } }, "color": { "description": "The color of the field in the app", "enum": [ "lime", "success", "emerald", "teal", "cyan", "sky", "blue", "accent", "violet", "fuchsia", "pink", "rose", "warn", "orange", "amber", "danger", "neutral", "stone", "zinc", "primary" ], "nullable": true, "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" } } }, { "additionalProperties": false, "title": "Divider Field", "type": "object", "required": [ "type", "category", "name" ], "properties": { "type": { "type": "string", "enum": [ "divider" ] }, "category": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" } } }, "color": { "description": "The color of the field in the app", "enum": [ "lime", "success", "emerald", "teal", "cyan", "sky", "blue", "accent", "violet", "fuchsia", "pink", "rose", "warn", "orange", "amber", "danger", "neutral", "stone", "zinc", "primary" ], "nullable": true, "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" } } }, { "additionalProperties": false, "title": "Element Number Field", "type": "object", "required": [ "type", "category", "name" ], "properties": { "type": { "type": "string", "enum": [ "elementNumber" ] }, "category": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" } } }, "color": { "description": "The color of the field in the app", "enum": [ "lime", "success", "emerald", "teal", "cyan", "sky", "blue", "accent", "violet", "fuchsia", "pink", "rose", "warn", "orange", "amber", "danger", "neutral", "stone", "zinc", "primary" ], "nullable": true, "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" } } }, { "additionalProperties": false, "title": "Email Field", "type": "object", "required": [ "type", "category", "name" ], "properties": { "placeholder": { "description": "The placeholder value for the field, displayed in the app", "maxLength": 250, "default": "", "type": "string" }, "type": { "type": "string", "enum": [ "email" ] }, "category": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" } } }, "color": { "description": "The color of the field in the app", "enum": [ "lime", "success", "emerald", "teal", "cyan", "sky", "blue", "accent", "violet", "fuchsia", "pink", "rose", "warn", "orange", "amber", "danger", "neutral", "stone", "zinc", "primary" ], "nullable": true, "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" } } }, { "additionalProperties": false, "title": "File Field", "type": "object", "required": [ "type", "category", "name" ], "properties": { "fileViewMode": { "description": "The view mode that the file field appears in the app", "enum": [ "GALLERY", "GRID", "LIST" ], "default": "LIST", "type": "string" }, "type": { "type": "string", "enum": [ "file" ] }, "category": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" } } }, "color": { "description": "The color of the field in the app", "enum": [ "lime", "success", "emerald", "teal", "cyan", "sky", "blue", "accent", "violet", "fuchsia", "pink", "rose", "warn", "orange", "amber", "danger", "neutral", "stone", "zinc", "primary" ], "nullable": true, "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" } } }, { "additionalProperties": false, "title": "Formula Field", "type": "object", "required": [ "formula", "type", "category", "name" ], "properties": { "formula": { "description": "The raw formula used to calculate the field value", "type": "string" }, "type": { "type": "string", "enum": [ "formula" ] }, "category": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" } } }, "color": { "description": "The color of the field in the app", "enum": [ "lime", "success", "emerald", "teal", "cyan", "sky", "blue", "accent", "violet", "fuchsia", "pink", "rose", "warn", "orange", "amber", "danger", "neutral", "stone", "zinc", "primary" ], "nullable": true, "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" } } }, { "additionalProperties": false, "title": "Model View Field", "type": "object", "required": [ "type", "category", "name" ], "properties": { "modelOrientation": { "description": "The camera angle that the model view is displayed from", "enum": [ "FRONT", "ISOMETRIC", "LEFT", "RIGHT", "TOP" ], "default": "ISOMETRIC", "type": "string" }, "modelProjection": { "description": "The camera projection that the model view is displayed using", "enum": [ "ORTHOGRAPHIC", "PERSPECTIVE" ], "default": "ORTHOGRAPHIC", "type": "string" }, "type": { "type": "string", "enum": [ "modelView" ] }, "category": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" } } }, "color": { "description": "The color of the field in the app", "enum": [ "lime", "success", "emerald", "teal", "cyan", "sky", "blue", "accent", "violet", "fuchsia", "pink", "rose", "warn", "orange", "amber", "danger", "neutral", "stone", "zinc", "primary" ], "nullable": true, "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" } } }, { "additionalProperties": false, "title": "Model Name Field", "type": "object", "required": [ "type", "category", "name" ], "properties": { "type": { "type": "string", "enum": [ "modelName" ] }, "category": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" } } }, "color": { "description": "The color of the field in the app", "enum": [ "lime", "success", "emerald", "teal", "cyan", "sky", "blue", "accent", "violet", "fuchsia", "pink", "rose", "warn", "orange", "amber", "danger", "neutral", "stone", "zinc", "primary" ], "nullable": true, "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" } } }, { "additionalProperties": false, "title": "Number Field", "type": "object", "required": [ "format", "type", "category", "name" ], "properties": { "format": { "description": "The formatting used when the field value is displayed", "enum": [ "currency", "dollar", "dollarCents", "feetInches", "integer", "number", "numberCommas", "percent", "phone", "revitUnit", "text" ], "default": "number", "type": "string" }, "placeholder": { "description": "The placeholder value for the field, displayed in the app", "maxLength": 250, "default": "", "type": "string" }, "type": { "type": "string", "enum": [ "number" ] }, "category": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" } } }, "color": { "description": "The color of the field in the app", "enum": [ "lime", "success", "emerald", "teal", "cyan", "sky", "blue", "accent", "violet", "fuchsia", "pink", "rose", "warn", "orange", "amber", "danger", "neutral", "stone", "zinc", "primary" ], "nullable": true, "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" } } }, { "additionalProperties": false, "title": "Person Field", "type": "object", "required": [ "type", "category", "name" ], "properties": { "type": { "type": "string", "enum": [ "person" ] }, "category": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" } } }, "color": { "description": "The color of the field in the app", "enum": [ "lime", "success", "emerald", "teal", "cyan", "sky", "blue", "accent", "violet", "fuchsia", "pink", "rose", "warn", "orange", "amber", "danger", "neutral", "stone", "zinc", "primary" ], "nullable": true, "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" } } }, { "additionalProperties": false, "title": "Phone Field", "type": "object", "required": [ "type", "category", "name" ], "properties": { "placeholder": { "description": "The placeholder value for the field, displayed in the app", "maxLength": 250, "default": "", "type": "string" }, "type": { "type": "string", "enum": [ "phone" ] }, "category": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" } } }, "color": { "description": "The color of the field in the app", "enum": [ "lime", "success", "emerald", "teal", "cyan", "sky", "blue", "accent", "violet", "fuchsia", "pink", "rose", "warn", "orange", "amber", "danger", "neutral", "stone", "zinc", "primary" ], "nullable": true, "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" } } }, { "additionalProperties": false, "title": "Range Field", "type": "object", "required": [ "max", "min", "step", "stepMode", "type", "category", "name" ], "properties": { "dual": { "description": "If the upper and lower bounds are tracked", "default": false, "type": "boolean" }, "max": { "description": "The maximum value allowed for the range value", "default": 5, "type": "number" }, "min": { "description": "The minimum value allowed for the range value", "default": -5, "type": "number" }, "step": { "description": "The step size between values", "minimum": 1, "default": 1, "type": "number" }, "stepMode": { "default": true, "type": "boolean" }, "unit": { "description": "The unit of measurement to display for the range value", "maxLength": 50, "type": "string" }, "type": { "type": "string", "enum": [ "range" ] }, "category": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" } } }, "color": { "description": "The color of the field in the app", "enum": [ "lime", "success", "emerald", "teal", "cyan", "sky", "blue", "accent", "violet", "fuchsia", "pink", "rose", "warn", "orange", "amber", "danger", "neutral", "stone", "zinc", "primary" ], "nullable": true, "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" } } }, { "additionalProperties": false, "title": "References Field", "type": "object", "required": [ "type", "category", "name" ], "properties": { "type": { "type": "string", "enum": [ "references" ] }, "category": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" } } }, "color": { "description": "The color of the field in the app", "enum": [ "lime", "success", "emerald", "teal", "cyan", "sky", "blue", "accent", "violet", "fuchsia", "pink", "rose", "warn", "orange", "amber", "danger", "neutral", "stone", "zinc", "primary" ], "nullable": true, "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" } } }, { "additionalProperties": false, "deprecated": true, "title": "Related Field", "type": "object", "required": [ "canCreateRelatedElement", "disableRelatedHyperlink", "type", "category", "name", "reCat" ], "properties": { "canCreateRelatedElement": { "description": "If new related elements can be created for this field from within Layer", "default": true, "type": "boolean" }, "disableRelatedHyperlink": { "description": "If the hyperlink to related elements is disabled within Layer", "default": false, "type": "boolean" }, "elementPaneDisplayFields": { "description": "Fields to display in the element pane for each related element", "type": "array", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" } } } }, "elementSelectDisplayFields": { "description": "Fields to display in the element select for related element selection", "type": "array", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" } } } }, "multiple": { "description": "If multiple related objects can be selected", "default": false, "type": "boolean" }, "placeholder": { "description": "The placeholder value for the field, displayed in the app", "maxLength": 250, "default": "", "type": "string" }, "trackQuantity": { "description": "If the quantity of the objects in the field are tracked", "default": false, "type": "boolean" }, "type": { "type": "string", "enum": [ "related" ] }, "category": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" } } }, "color": { "description": "The color of the field in the app", "enum": [ "lime", "success", "emerald", "teal", "cyan", "sky", "blue", "accent", "violet", "fuchsia", "pink", "rose", "warn", "orange", "amber", "danger", "neutral", "stone", "zinc", "primary" ], "nullable": true, "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" }, "reCat": { "description": "The category that the related field is in", "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" } } } } }, { "additionalProperties": false, "title": "Relationship Field", "type": "object", "required": [ "type", "category", "name", "reCat", "relationType" ], "properties": { "elementPaneDisplayFields": { "description": "Fields to display in the element pane for each related element", "type": "array", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" } } } }, "multiple": { "description": "If multiple related objects can be selected", "default": false, "type": "boolean" }, "trackQuantity": { "description": "If the quantity of the objects in the field are tracked", "default": false, "type": "boolean" }, "type": { "type": "string", "enum": [ "relatedV2" ] }, "category": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" } } }, "color": { "description": "The color of the field in the app", "enum": [ "lime", "success", "emerald", "teal", "cyan", "sky", "blue", "accent", "violet", "fuchsia", "pink", "rose", "warn", "orange", "amber", "danger", "neutral", "stone", "zinc", "primary" ], "nullable": true, "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" }, "reCat": { "description": "The category that the related field is in", "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" } } }, "relationType": { "enum": [ "manual", "spatial" ], "type": "string" } } }, { "additionalProperties": false, "title": "Revit Parameters Field", "type": "object", "required": [ "paramLabels", "type", "category", "name", "param" ], "properties": { "paramLabels": { "description": "If the parameter labels are displayed", "enum": [ "show_labels", "hide_labels" ], "default": "show_labels", "type": "string" }, "type": { "type": "string", "enum": [ "revitParam" ] }, "category": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" } } }, "color": { "description": "The color of the field in the app", "enum": [ "lime", "success", "emerald", "teal", "cyan", "sky", "blue", "accent", "violet", "fuchsia", "pink", "rose", "warn", "orange", "amber", "danger", "neutral", "stone", "zinc", "primary" ], "nullable": true, "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" }, "param": { "description": "The Revit parameters that are displayed in the field", "type": "array", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" } } } } } }, { "additionalProperties": false, "title": "Select Field", "type": "object", "required": [ "options", "type", "category", "name" ], "properties": { "multiple": { "description": "If multiple options can be selected", "default": false, "type": "boolean" }, "options": { "description": "The available options, in the order they should be displayed. On update this is a set operation: the submitted array replaces the full options list. To preserve an existing option and its element references, include the option with its original id; options omitted from the array are removed. To add a new option, include it without an id and one will be generated. Responses include each option ID, and element select writes may later refer to either those IDs or the option labels.", "minItems": 1, "type": "array", "items": { "type": "object", "required": [ "label", "paletteColor" ], "properties": { "id": { "description": "Select option ID. Responses include this value; create/update payloads may omit it and let Layer generate one.", "type": "string" }, "label": { "description": "The label of the option", "type": "string" }, "paletteColor": { "default": "accent", "description": "The color that the option is displayed in", "enum": [ "lime", "success", "emerald", "teal", "cyan", "sky", "blue", "accent", "violet", "fuchsia", "pink", "rose", "warn", "orange", "amber", "danger", "neutral", "stone", "zinc", "primary" ], "type": "string" }, "value": { "description": "The numerical value assigned to the option", "minimum": 0, "type": "number" } } } }, "optionValue": { "description": "If a numerical option value are set on each option", "default": false, "type": "boolean" }, "showOptionValue": { "description": "If the numerical option value aree displayed", "default": false, "type": "boolean" }, "typeToCreate": { "description": "If the user is able to create new options by typing within the field", "default": false, "type": "boolean" }, "type": { "type": "string", "enum": [ "select" ] }, "category": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" } } }, "color": { "description": "The color of the field in the app", "enum": [ "lime", "success", "emerald", "teal", "cyan", "sky", "blue", "accent", "violet", "fuchsia", "pink", "rose", "warn", "orange", "amber", "danger", "neutral", "stone", "zinc", "primary" ], "nullable": true, "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" } } }, { "additionalProperties": false, "title": "Spatial Relationships Field", "type": "object", "required": [ "type", "category", "name" ], "properties": { "groupSpatialValues": { "description": "If the spatial relationships are grouped by value", "default": false, "type": "boolean" }, "spatialFilterCategoryId": { "description": "The category ID to filter the spatial relationships by", "nullable": true, "type": "string" }, "spatialPhases": { "enum": [ "ALL", "LATEST" ], "default": "ALL", "type": "string" }, "type": { "type": "string", "enum": [ "spatialRelationships" ] }, "category": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" } } }, "color": { "description": "The color of the field in the app", "enum": [ "lime", "success", "emerald", "teal", "cyan", "sky", "blue", "accent", "violet", "fuchsia", "pink", "rose", "warn", "orange", "amber", "danger", "neutral", "stone", "zinc", "primary" ], "nullable": true, "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" } } }, { "additionalProperties": false, "title": "Text Field", "type": "object", "required": [ "type", "category", "name" ], "properties": { "placeholder": { "description": "The placeholder value for the field, displayed in the app", "maxLength": 250, "default": "", "type": "string" }, "type": { "type": "string", "enum": [ "text" ] }, "category": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" } } }, "color": { "description": "The color of the field in the app", "enum": [ "lime", "success", "emerald", "teal", "cyan", "sky", "blue", "accent", "violet", "fuchsia", "pink", "rose", "warn", "orange", "amber", "danger", "neutral", "stone", "zinc", "primary" ], "nullable": true, "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" } } }, { "additionalProperties": false, "title": "Toggle Field", "type": "object", "required": [ "type", "category", "name" ], "properties": { "type": { "type": "string", "enum": [ "toggle" ] }, "category": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" } } }, "color": { "description": "The color of the field in the app", "enum": [ "lime", "success", "emerald", "teal", "cyan", "sky", "blue", "accent", "violet", "fuchsia", "pink", "rose", "warn", "orange", "amber", "danger", "neutral", "stone", "zinc", "primary" ], "nullable": true, "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" } } }, { "additionalProperties": false, "title": "Updated At Field", "type": "object", "required": [ "type", "category", "name" ], "properties": { "type": { "type": "string", "enum": [ "updatedat" ] }, "category": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" } } }, "color": { "description": "The color of the field in the app", "enum": [ "lime", "success", "emerald", "teal", "cyan", "sky", "blue", "accent", "violet", "fuchsia", "pink", "rose", "warn", "orange", "amber", "danger", "neutral", "stone", "zinc", "primary" ], "nullable": true, "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" } } }, { "additionalProperties": false, "title": "Updated By Field", "type": "object", "required": [ "type", "category", "name" ], "properties": { "type": { "type": "string", "enum": [ "updatedby" ] }, "category": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" } } }, "color": { "description": "The color of the field in the app", "enum": [ "lime", "success", "emerald", "teal", "cyan", "sky", "blue", "accent", "violet", "fuchsia", "pink", "rose", "warn", "orange", "amber", "danger", "neutral", "stone", "zinc", "primary" ], "nullable": true, "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" } } }, { "additionalProperties": false, "title": "Model Version History Field", "type": "object", "required": [ "type", "category", "name" ], "properties": { "type": { "type": "string", "enum": [ "versionHistory" ] }, "category": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" } } }, "color": { "description": "The color of the field in the app", "enum": [ "lime", "success", "emerald", "teal", "cyan", "sky", "blue", "accent", "violet", "fuchsia", "pink", "rose", "warn", "orange", "amber", "danger", "neutral", "stone", "zinc", "primary" ], "nullable": true, "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" } } } ] }, "tool": { "type": "string", "enum": [ "createField" ] } } }, { "type": "object", "required": [ "body", "fieldId", "tool" ], "properties": { "body": { "description": "The properties to update on the field. Note that the field \"type\" property cannot be changed. Including the \"type\" property is optional, as it will be assumed based on the field that is being updated.", "type": "object", "oneOf": [ { "additionalProperties": false, "title": "Text Area Field", "type": "object", "required": [ "type" ], "properties": { "placeholder": { "description": "The placeholder value for the field, displayed in the app", "maxLength": 250, "type": "string" }, "textAreaSize": { "description": "The size that the text area appears in the app", "enum": [ "LARGE", "MEDIUM", "SMALL" ], "type": "string" }, "type": { "type": "string", "enum": [ "area" ] }, "color": { "description": "The color of the field in the app", "enum": [ "lime", "success", "emerald", "teal", "cyan", "sky", "blue", "accent", "violet", "fuchsia", "pink", "rose", "warn", "orange", "amber", "danger", "neutral", "stone", "zinc", "primary" ], "nullable": true, "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" } } }, { "additionalProperties": false, "title": "Barcode Field", "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "barcode" ] }, "color": { "description": "The color of the field in the app", "enum": [ "lime", "success", "emerald", "teal", "cyan", "sky", "blue", "accent", "violet", "fuchsia", "pink", "rose", "warn", "orange", "amber", "danger", "neutral", "stone", "zinc", "primary" ], "nullable": true, "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" } } }, { "additionalProperties": false, "title": "Created At Field", "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "createdat" ] }, "color": { "description": "The color of the field in the app", "enum": [ "lime", "success", "emerald", "teal", "cyan", "sky", "blue", "accent", "violet", "fuchsia", "pink", "rose", "warn", "orange", "amber", "danger", "neutral", "stone", "zinc", "primary" ], "nullable": true, "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" } } }, { "additionalProperties": false, "title": "Created By Field", "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "createdby" ] }, "color": { "description": "The color of the field in the app", "enum": [ "lime", "success", "emerald", "teal", "cyan", "sky", "blue", "accent", "violet", "fuchsia", "pink", "rose", "warn", "orange", "amber", "danger", "neutral", "stone", "zinc", "primary" ], "nullable": true, "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" } } }, { "additionalProperties": false, "title": "Date Field", "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "date" ] }, "color": { "description": "The color of the field in the app", "enum": [ "lime", "success", "emerald", "teal", "cyan", "sky", "blue", "accent", "violet", "fuchsia", "pink", "rose", "warn", "orange", "amber", "danger", "neutral", "stone", "zinc", "primary" ], "nullable": true, "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" } } }, { "additionalProperties": false, "title": "Divider Field", "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "divider" ] }, "color": { "description": "The color of the field in the app", "enum": [ "lime", "success", "emerald", "teal", "cyan", "sky", "blue", "accent", "violet", "fuchsia", "pink", "rose", "warn", "orange", "amber", "danger", "neutral", "stone", "zinc", "primary" ], "nullable": true, "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" } } }, { "additionalProperties": false, "title": "Element Number Field", "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "elementNumber" ] }, "color": { "description": "The color of the field in the app", "enum": [ "lime", "success", "emerald", "teal", "cyan", "sky", "blue", "accent", "violet", "fuchsia", "pink", "rose", "warn", "orange", "amber", "danger", "neutral", "stone", "zinc", "primary" ], "nullable": true, "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" }, "format": { "description": "The formatting used when the field value is displayed", "enum": [ "currency", "dollar", "dollarCents", "feetInches", "integer", "number", "numberCommas", "percent", "phone", "revitUnit", "text" ], "type": "string" } } }, { "additionalProperties": false, "title": "Email Field", "type": "object", "required": [ "type" ], "properties": { "placeholder": { "description": "The placeholder value for the field, displayed in the app", "maxLength": 250, "type": "string" }, "type": { "type": "string", "enum": [ "email" ] }, "color": { "description": "The color of the field in the app", "enum": [ "lime", "success", "emerald", "teal", "cyan", "sky", "blue", "accent", "violet", "fuchsia", "pink", "rose", "warn", "orange", "amber", "danger", "neutral", "stone", "zinc", "primary" ], "nullable": true, "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" } } }, { "additionalProperties": false, "title": "File Field", "type": "object", "required": [ "type" ], "properties": { "fileViewMode": { "description": "The view mode that the file field appears in the app", "enum": [ "GALLERY", "GRID", "LIST" ], "type": "string" }, "type": { "type": "string", "enum": [ "file" ] }, "color": { "description": "The color of the field in the app", "enum": [ "lime", "success", "emerald", "teal", "cyan", "sky", "blue", "accent", "violet", "fuchsia", "pink", "rose", "warn", "orange", "amber", "danger", "neutral", "stone", "zinc", "primary" ], "nullable": true, "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" } } }, { "additionalProperties": false, "title": "Formula Field", "type": "object", "required": [ "type" ], "properties": { "formula": { "description": "The raw formula used to calculate the field value", "type": "string" }, "type": { "type": "string", "enum": [ "formula" ] }, "color": { "description": "The color of the field in the app", "enum": [ "lime", "success", "emerald", "teal", "cyan", "sky", "blue", "accent", "violet", "fuchsia", "pink", "rose", "warn", "orange", "amber", "danger", "neutral", "stone", "zinc", "primary" ], "nullable": true, "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" } } }, { "additionalProperties": false, "title": "Model View Field", "type": "object", "required": [ "type" ], "properties": { "modelOrientation": { "description": "The camera angle that the model view is displayed from", "enum": [ "FRONT", "ISOMETRIC", "LEFT", "RIGHT", "TOP" ], "type": "string" }, "modelProjection": { "description": "The camera projection that the model view is displayed using", "enum": [ "ORTHOGRAPHIC", "PERSPECTIVE" ], "type": "string" }, "type": { "type": "string", "enum": [ "modelView" ] }, "color": { "description": "The color of the field in the app", "enum": [ "lime", "success", "emerald", "teal", "cyan", "sky", "blue", "accent", "violet", "fuchsia", "pink", "rose", "warn", "orange", "amber", "danger", "neutral", "stone", "zinc", "primary" ], "nullable": true, "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" } } }, { "additionalProperties": false, "title": "Model Name Field", "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "modelName" ] }, "color": { "description": "The color of the field in the app", "enum": [ "lime", "success", "emerald", "teal", "cyan", "sky", "blue", "accent", "violet", "fuchsia", "pink", "rose", "warn", "orange", "amber", "danger", "neutral", "stone", "zinc", "primary" ], "nullable": true, "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" } } }, { "additionalProperties": false, "title": "Number Field", "type": "object", "required": [ "format", "type" ], "properties": { "format": { "description": "The formatting used when the field value is displayed", "enum": [ "currency", "dollar", "dollarCents", "feetInches", "integer", "number", "numberCommas", "percent", "phone", "revitUnit", "text" ], "type": "string" }, "placeholder": { "description": "The placeholder value for the field, displayed in the app", "maxLength": 250, "type": "string" }, "type": { "type": "string", "enum": [ "number" ] }, "color": { "description": "The color of the field in the app", "enum": [ "lime", "success", "emerald", "teal", "cyan", "sky", "blue", "accent", "violet", "fuchsia", "pink", "rose", "warn", "orange", "amber", "danger", "neutral", "stone", "zinc", "primary" ], "nullable": true, "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" } } }, { "additionalProperties": false, "title": "Person Field", "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "person" ] }, "color": { "description": "The color of the field in the app", "enum": [ "lime", "success", "emerald", "teal", "cyan", "sky", "blue", "accent", "violet", "fuchsia", "pink", "rose", "warn", "orange", "amber", "danger", "neutral", "stone", "zinc", "primary" ], "nullable": true, "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" } } }, { "additionalProperties": false, "title": "Phone Field", "type": "object", "required": [ "type" ], "properties": { "placeholder": { "description": "The placeholder value for the field, displayed in the app", "maxLength": 250, "type": "string" }, "type": { "type": "string", "enum": [ "phone" ] }, "color": { "description": "The color of the field in the app", "enum": [ "lime", "success", "emerald", "teal", "cyan", "sky", "blue", "accent", "violet", "fuchsia", "pink", "rose", "warn", "orange", "amber", "danger", "neutral", "stone", "zinc", "primary" ], "nullable": true, "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" } } }, { "additionalProperties": false, "title": "Range Field", "type": "object", "required": [ "type" ], "properties": { "dual": { "description": "If the upper and lower bounds are tracked", "type": "boolean" }, "max": { "description": "The maximum value allowed for the range value", "type": "number" }, "min": { "description": "The minimum value allowed for the range value", "type": "number" }, "step": { "description": "The step size between values", "minimum": 1, "type": "number" }, "stepMode": { "type": "boolean" }, "unit": { "description": "The unit of measurement to display for the range value", "maxLength": 50, "type": "string" }, "type": { "type": "string", "enum": [ "range" ] }, "color": { "description": "The color of the field in the app", "enum": [ "lime", "success", "emerald", "teal", "cyan", "sky", "blue", "accent", "violet", "fuchsia", "pink", "rose", "warn", "orange", "amber", "danger", "neutral", "stone", "zinc", "primary" ], "nullable": true, "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" } } }, { "additionalProperties": false, "title": "References Field", "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "references" ] }, "color": { "description": "The color of the field in the app", "enum": [ "lime", "success", "emerald", "teal", "cyan", "sky", "blue", "accent", "violet", "fuchsia", "pink", "rose", "warn", "orange", "amber", "danger", "neutral", "stone", "zinc", "primary" ], "nullable": true, "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" } } }, { "additionalProperties": false, "deprecated": true, "title": "Related Field", "type": "object", "required": [ "canCreateRelatedElement", "disableRelatedHyperlink", "type" ], "properties": { "canCreateRelatedElement": { "description": "If new related elements can be created for this field from within Layer", "type": "boolean" }, "disableRelatedHyperlink": { "description": "If the hyperlink to related elements is disabled within Layer", "type": "boolean" }, "elementPaneDisplayFields": { "description": "Fields to display in the element pane for each related element", "type": "array", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" } } } }, "elementSelectDisplayFields": { "description": "Fields to display in the element select for related element selection", "type": "array", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" } } } }, "multiple": { "description": "If multiple related objects can be selected", "type": "boolean" }, "placeholder": { "description": "The placeholder value for the field, displayed in the app", "maxLength": 250, "type": "string" }, "trackQuantity": { "description": "If the quantity of the objects in the field are tracked", "type": "boolean" }, "type": { "type": "string", "enum": [ "related" ] }, "color": { "description": "The color of the field in the app", "enum": [ "lime", "success", "emerald", "teal", "cyan", "sky", "blue", "accent", "violet", "fuchsia", "pink", "rose", "warn", "orange", "amber", "danger", "neutral", "stone", "zinc", "primary" ], "nullable": true, "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" }, "reCat": { "description": "The category that the related field is in", "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" } } } } }, { "additionalProperties": false, "title": "Relationship Field", "type": "object", "required": [ "type", "relationType" ], "properties": { "elementPaneDisplayFields": { "description": "Fields to display in the element pane for each related element", "type": "array", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" } } } }, "multiple": { "description": "If multiple related objects can be selected", "type": "boolean" }, "trackQuantity": { "description": "If the quantity of the objects in the field are tracked", "type": "boolean" }, "type": { "type": "string", "enum": [ "relatedV2" ] }, "color": { "description": "The color of the field in the app", "enum": [ "lime", "success", "emerald", "teal", "cyan", "sky", "blue", "accent", "violet", "fuchsia", "pink", "rose", "warn", "orange", "amber", "danger", "neutral", "stone", "zinc", "primary" ], "nullable": true, "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" }, "reCat": { "description": "The category that the related field is in", "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" } } }, "relationType": { "enum": [ "manual", "automatic", "spatial" ], "type": "string" } } }, { "additionalProperties": false, "title": "Revit Parameters Field", "type": "object", "required": [ "type" ], "properties": { "paramLabels": { "description": "If the parameter labels are displayed", "enum": [ "show_labels", "hide_labels" ], "type": "string" }, "type": { "type": "string", "enum": [ "revitParam" ] }, "color": { "description": "The color of the field in the app", "enum": [ "lime", "success", "emerald", "teal", "cyan", "sky", "blue", "accent", "violet", "fuchsia", "pink", "rose", "warn", "orange", "amber", "danger", "neutral", "stone", "zinc", "primary" ], "nullable": true, "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" }, "param": { "description": "The Revit parameters that are displayed in the field", "type": "array", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" } } } } } }, { "additionalProperties": false, "title": "Select Field", "type": "object", "required": [ "type" ], "properties": { "multiple": { "description": "If multiple options can be selected", "type": "boolean" }, "options": { "description": "The available options, in the order they should be displayed. On update this is a set operation: the submitted array replaces the full options list. To preserve an existing option and its element references, include the option with its original id; options omitted from the array are removed. To add a new option, include it without an id and one will be generated. Responses include each option ID, and element select writes may later refer to either those IDs or the option labels.", "minItems": 1, "type": "array", "items": { "type": "object", "required": [ "label", "paletteColor" ], "properties": { "id": { "description": "Select option ID. Responses include this value; create/update payloads may omit it and let Layer generate one.", "type": "string" }, "label": { "description": "The label of the option", "type": "string" }, "paletteColor": { "default": "accent", "description": "The color that the option is displayed in", "enum": [ "lime", "success", "emerald", "teal", "cyan", "sky", "blue", "accent", "violet", "fuchsia", "pink", "rose", "warn", "orange", "amber", "danger", "neutral", "stone", "zinc", "primary" ], "type": "string" }, "value": { "description": "The numerical value assigned to the option", "minimum": 0, "type": "number" } } } }, "optionValue": { "description": "If a numerical option value are set on each option", "type": "boolean" }, "showOptionValue": { "description": "If the numerical option value aree displayed", "type": "boolean" }, "typeToCreate": { "description": "If the user is able to create new options by typing within the field", "type": "boolean" }, "type": { "type": "string", "enum": [ "select" ] }, "color": { "description": "The color of the field in the app", "enum": [ "lime", "success", "emerald", "teal", "cyan", "sky", "blue", "accent", "violet", "fuchsia", "pink", "rose", "warn", "orange", "amber", "danger", "neutral", "stone", "zinc", "primary" ], "nullable": true, "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" } } }, { "additionalProperties": false, "title": "Spatial Relationships Field", "type": "object", "required": [ "type" ], "properties": { "groupSpatialValues": { "description": "If the spatial relationships are grouped by value", "type": "boolean" }, "spatialFilterCategoryId": { "description": "The category ID to filter the spatial relationships by", "nullable": true, "type": "string" }, "spatialPhases": { "enum": [ "ALL", "LATEST" ], "type": "string" }, "type": { "type": "string", "enum": [ "spatialRelationships" ] }, "color": { "description": "The color of the field in the app", "enum": [ "lime", "success", "emerald", "teal", "cyan", "sky", "blue", "accent", "violet", "fuchsia", "pink", "rose", "warn", "orange", "amber", "danger", "neutral", "stone", "zinc", "primary" ], "nullable": true, "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" } } }, { "additionalProperties": false, "title": "Text Field", "type": "object", "required": [ "type" ], "properties": { "placeholder": { "description": "The placeholder value for the field, displayed in the app", "maxLength": 250, "type": "string" }, "type": { "type": "string", "enum": [ "text" ] }, "color": { "description": "The color of the field in the app", "enum": [ "lime", "success", "emerald", "teal", "cyan", "sky", "blue", "accent", "violet", "fuchsia", "pink", "rose", "warn", "orange", "amber", "danger", "neutral", "stone", "zinc", "primary" ], "nullable": true, "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" } } }, { "additionalProperties": false, "title": "Toggle Field", "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "toggle" ] }, "color": { "description": "The color of the field in the app", "enum": [ "lime", "success", "emerald", "teal", "cyan", "sky", "blue", "accent", "violet", "fuchsia", "pink", "rose", "warn", "orange", "amber", "danger", "neutral", "stone", "zinc", "primary" ], "nullable": true, "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" } } }, { "additionalProperties": false, "title": "Updated At Field", "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "updatedat" ] }, "color": { "description": "The color of the field in the app", "enum": [ "lime", "success", "emerald", "teal", "cyan", "sky", "blue", "accent", "violet", "fuchsia", "pink", "rose", "warn", "orange", "amber", "danger", "neutral", "stone", "zinc", "primary" ], "nullable": true, "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" } } }, { "additionalProperties": false, "title": "Updated By Field", "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "updatedby" ] }, "color": { "description": "The color of the field in the app", "enum": [ "lime", "success", "emerald", "teal", "cyan", "sky", "blue", "accent", "violet", "fuchsia", "pink", "rose", "warn", "orange", "amber", "danger", "neutral", "stone", "zinc", "primary" ], "nullable": true, "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" } } }, { "additionalProperties": false, "title": "Model Version History Field", "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "versionHistory" ] }, "color": { "description": "The color of the field in the app", "enum": [ "lime", "success", "emerald", "teal", "cyan", "sky", "blue", "accent", "violet", "fuchsia", "pink", "rose", "warn", "orange", "amber", "danger", "neutral", "stone", "zinc", "primary" ], "nullable": true, "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" } } } ] }, "fieldId": { "description": "Field ID", "type": "string" }, "tool": { "type": "string", "enum": [ "updateField" ] } } }, { "type": "object", "required": [ "fieldId", "tool" ], "properties": { "fieldId": { "description": "Field ID", "type": "string" }, "tool": { "type": "string", "enum": [ "deleteField" ] } } }, { "type": "object", "required": [ "fileId", "tool" ], "properties": { "fileId": { "description": "File ID", "type": "string" }, "tool": { "type": "string", "enum": [ "deleteFile" ] } } } ] } } } } } }, "required": true }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "projectId", "required": true, "description": "Project ID" } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "results", "summary" ], "properties": { "results": { "type": "array", "items": { "type": "object", "required": [ "index", "status", "tool" ], "properties": { "data": {}, "error": { "type": "string" }, "index": { "description": "Original position in the actions array", "type": "number" }, "originalArgs": {}, "status": { "anyOf": [ { "type": "string", "enum": [ "success" ] }, { "type": "string", "enum": [ "error" ] } ] }, "tool": { "description": "The action type that was executed", "type": "string" } } } }, "summary": { "type": "object", "required": [ "failed", "succeeded", "total" ], "properties": { "failed": { "type": "number" }, "succeeded": { "type": "number" }, "total": { "type": "number" } } } } } } } }, "413": { "description": "Response payload exceeded the configured size limit for this API.", "content": { "application/json": { "schema": { "description": "Response payload exceeded the configured size limit for this API.", "properties": { "code": { "description": "Stable machine-readable error code.", "type": "string" }, "error": { "description": "Human-readable error message.", "type": "string" } }, "required": [ "code", "error" ], "type": "object" } } } }, "4XX": { "description": "Default error response.", "content": { "application/json": { "schema": { "description": "Default error response.", "type": "object", "required": [ "error" ], "properties": { "error": { "description": "Human-readable error message.", "type": "string" } } } } } } } } } }, "servers": [ { "url": "https://api.layer.team" } ], "x-readme": { "samples-languages": [ "curl" ] } } ```