--- updatedAt: 2026-06-12T20:00:32.000Z agentTools: projectIndex: https://layer-api.readme.io/llms.txt --- # Get Fields Get all fields in a project. Optionally, a categoryId or viewId can be provided to return fields inside a particular category or view. # 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}/fields": { "get": { "operationId": "getFields", "summary": "Get Fields", "tags": [ "Fields" ], "description": "Get all fields in a project. Optionally, a categoryId or viewId can be provided to return fields inside a particular category or view.", "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "categoryId", "required": false, "description": "Include only fields in a specific category" }, { "schema": { "type": "string" }, "in": "query", "name": "viewId", "required": false, "description": "Include only fields in a specific view" }, { "schema": { "type": "string" }, "in": "path", "name": "projectId", "required": true, "description": "Project ID" } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "List of Layer Fields", "content": { "application/json": { "schema": { "description": "List of Layer Fields", "type": "object", "required": [ "fields", "total" ], "properties": { "category": { "description": "Summary information about the category associated with these fields (if a categoryId is provided)", "type": "object", "required": [ "name" ], "properties": { "name": { "description": "Name of the category", "type": "string" } } }, "fields": { "description": "List of Layer Fields", "type": "array", "items": { "anyOf": [ { "additionalProperties": false, "title": "Text Area Field", "type": "object", "required": [ "type", "category", "createdAt", "createdBy", "description", "id", "name", "updatedAt", "updatedBy" ], "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" ] }, "category": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "description": "Name of the category that the field is available in", "type": "string" } } }, "color": { "description": "The color of the field in the app", "type": "string" }, "createdAt": { "description": "Date & time the field was created", "format": "date-time", "nullable": true, "type": "string" }, "createdBy": { "description": "Name of the user who created the field", "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "id": { "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" }, "updatedAt": { "description": "Date & time the field was last updated", "format": "date-time", "nullable": true, "type": "string" }, "updatedBy": { "description": "Name of the user who last updated the field", "type": "string" } } }, { "additionalProperties": false, "title": "Barcode Field", "type": "object", "required": [ "type", "category", "createdAt", "createdBy", "description", "id", "name", "updatedAt", "updatedBy" ], "properties": { "type": { "type": "string", "enum": [ "barcode" ] }, "category": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "description": "Name of the category that the field is available in", "type": "string" } } }, "color": { "description": "The color of the field in the app", "type": "string" }, "createdAt": { "description": "Date & time the field was created", "format": "date-time", "nullable": true, "type": "string" }, "createdBy": { "description": "Name of the user who created the field", "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "id": { "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" }, "updatedAt": { "description": "Date & time the field was last updated", "format": "date-time", "nullable": true, "type": "string" }, "updatedBy": { "description": "Name of the user who last updated the field", "type": "string" } } }, { "additionalProperties": false, "title": "Created At Field", "type": "object", "required": [ "type", "category", "createdAt", "createdBy", "description", "id", "name", "updatedAt", "updatedBy" ], "properties": { "type": { "type": "string", "enum": [ "createdat" ] }, "category": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "description": "Name of the category that the field is available in", "type": "string" } } }, "color": { "description": "The color of the field in the app", "type": "string" }, "createdAt": { "description": "Date & time the field was created", "format": "date-time", "nullable": true, "type": "string" }, "createdBy": { "description": "Name of the user who created the field", "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "id": { "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" }, "updatedAt": { "description": "Date & time the field was last updated", "format": "date-time", "nullable": true, "type": "string" }, "updatedBy": { "description": "Name of the user who last updated the field", "type": "string" } } }, { "additionalProperties": false, "title": "Created By Field", "type": "object", "required": [ "type", "category", "createdAt", "createdBy", "description", "id", "name", "updatedAt", "updatedBy" ], "properties": { "type": { "type": "string", "enum": [ "createdby" ] }, "category": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "description": "Name of the category that the field is available in", "type": "string" } } }, "color": { "description": "The color of the field in the app", "type": "string" }, "createdAt": { "description": "Date & time the field was created", "format": "date-time", "nullable": true, "type": "string" }, "createdBy": { "description": "Name of the user who created the field", "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "id": { "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" }, "updatedAt": { "description": "Date & time the field was last updated", "format": "date-time", "nullable": true, "type": "string" }, "updatedBy": { "description": "Name of the user who last updated the field", "type": "string" } } }, { "additionalProperties": false, "title": "Date Field", "type": "object", "required": [ "type", "category", "createdAt", "createdBy", "description", "id", "name", "updatedAt", "updatedBy" ], "properties": { "type": { "type": "string", "enum": [ "date" ] }, "category": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "description": "Name of the category that the field is available in", "type": "string" } } }, "color": { "description": "The color of the field in the app", "type": "string" }, "createdAt": { "description": "Date & time the field was created", "format": "date-time", "nullable": true, "type": "string" }, "createdBy": { "description": "Name of the user who created the field", "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "id": { "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" }, "updatedAt": { "description": "Date & time the field was last updated", "format": "date-time", "nullable": true, "type": "string" }, "updatedBy": { "description": "Name of the user who last updated the field", "type": "string" } } }, { "additionalProperties": false, "title": "Divider Field", "type": "object", "required": [ "type", "category", "createdAt", "createdBy", "description", "id", "name", "updatedAt", "updatedBy" ], "properties": { "type": { "type": "string", "enum": [ "divider" ] }, "category": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "description": "Name of the category that the field is available in", "type": "string" } } }, "color": { "description": "The color of the field in the app", "type": "string" }, "createdAt": { "description": "Date & time the field was created", "format": "date-time", "nullable": true, "type": "string" }, "createdBy": { "description": "Name of the user who created the field", "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "id": { "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" }, "updatedAt": { "description": "Date & time the field was last updated", "format": "date-time", "nullable": true, "type": "string" }, "updatedBy": { "description": "Name of the user who last updated the field", "type": "string" } } }, { "additionalProperties": false, "title": "Element Number Field", "type": "object", "required": [ "type", "category", "createdAt", "createdBy", "description", "id", "name", "updatedAt", "updatedBy" ], "properties": { "type": { "type": "string", "enum": [ "elementNumber" ] }, "category": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "description": "Name of the category that the field is available in", "type": "string" } } }, "color": { "description": "The color of the field in the app", "type": "string" }, "createdAt": { "description": "Date & time the field was created", "format": "date-time", "nullable": true, "type": "string" }, "createdBy": { "description": "Name of the user who created the field", "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "id": { "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" }, "updatedAt": { "description": "Date & time the field was last updated", "format": "date-time", "nullable": true, "type": "string" }, "updatedBy": { "description": "Name of the user who last updated the field", "type": "string" } } }, { "additionalProperties": false, "title": "Email Field", "type": "object", "required": [ "type", "category", "createdAt", "createdBy", "description", "id", "name", "updatedAt", "updatedBy" ], "properties": { "placeholder": { "description": "The placeholder value for the field, displayed in the app", "maxLength": 250, "type": "string" }, "type": { "type": "string", "enum": [ "email" ] }, "category": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "description": "Name of the category that the field is available in", "type": "string" } } }, "color": { "description": "The color of the field in the app", "type": "string" }, "createdAt": { "description": "Date & time the field was created", "format": "date-time", "nullable": true, "type": "string" }, "createdBy": { "description": "Name of the user who created the field", "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "id": { "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" }, "updatedAt": { "description": "Date & time the field was last updated", "format": "date-time", "nullable": true, "type": "string" }, "updatedBy": { "description": "Name of the user who last updated the field", "type": "string" } } }, { "additionalProperties": false, "title": "File Field", "type": "object", "required": [ "type", "category", "createdAt", "createdBy", "description", "id", "name", "updatedAt", "updatedBy" ], "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" ] }, "category": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "description": "Name of the category that the field is available in", "type": "string" } } }, "color": { "description": "The color of the field in the app", "type": "string" }, "createdAt": { "description": "Date & time the field was created", "format": "date-time", "nullable": true, "type": "string" }, "createdBy": { "description": "Name of the user who created the field", "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "id": { "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" }, "updatedAt": { "description": "Date & time the field was last updated", "format": "date-time", "nullable": true, "type": "string" }, "updatedBy": { "description": "Name of the user who last updated the field", "type": "string" } } }, { "additionalProperties": false, "title": "Formula Field", "type": "object", "required": [ "formula", "type", "category", "createdAt", "createdBy", "description", "id", "name", "updatedAt", "updatedBy" ], "properties": { "formula": { "description": "The raw formula used to calculate the field value", "type": "string" }, "type": { "type": "string", "enum": [ "formula" ] }, "category": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "description": "Name of the category that the field is available in", "type": "string" } } }, "color": { "description": "The color of the field in the app", "type": "string" }, "createdAt": { "description": "Date & time the field was created", "format": "date-time", "nullable": true, "type": "string" }, "createdBy": { "description": "Name of the user who created the field", "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "id": { "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" }, "updatedAt": { "description": "Date & time the field was last updated", "format": "date-time", "nullable": true, "type": "string" }, "updatedBy": { "description": "Name of the user who last updated the field", "type": "string" } } }, { "additionalProperties": false, "title": "Lookup field", "type": "object", "required": [ "lookupTarget", "lookupType", "type", "category", "createdAt", "createdBy", "description", "id", "name", "updatedAt", "updatedBy" ], "properties": { "autoSource": { "description": "For auto lookup fields, the field in the same category as this field to compare against the autoTarget", "nullable": true, "type": "object", "required": [ "id", "type" ], "properties": { "id": { "description": "The ID of the field to compare against the autoTarget", "type": "string" }, "type": { "description": "The type of the field to compare against the autoTarget", "type": "string" } } }, "autoTarget": { "description": "For auto lookup fields, the field in the target category to compare against the autoSource", "nullable": true, "type": "object", "required": [ "id", "type" ], "properties": { "id": { "description": "The ID of the field to compare against the autoSource", "type": "string" }, "type": { "description": "The type of the field to compare against the autoSource", "type": "string" } } }, "lookupAggregation": { "description": "The aggregation type used to calculate the field value", "enum": [ "list", "sum", "average", "median", "min", "max", "range", "countUnique", "count", "countEmpty", "countNotEmpty", "unique" ], "type": "string" }, "lookupField": { "description": "For manual lookup fields, the related element field in the same category as this field to retrieve elements from", "nullable": true, "type": "object", "required": [ "id", "type" ], "properties": { "id": { "description": "The ID of the field", "type": "string" }, "type": { "description": "The type of the field", "type": "string" } } }, "lookupTarget": { "description": "For auto and manual lookup fields, the field to display as the result of the lookup", "type": "object", "required": [ "id", "type" ], "properties": { "id": { "description": "The ID of the field", "type": "string" }, "type": { "description": "The type of the field", "type": "string" } } }, "lookupType": { "description": "The type of lookup field configured (automatic or manual)", "enum": [ "automatic", "manual" ], "type": "string" }, "type": { "type": "string", "enum": [ "lookup" ] }, "category": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "description": "Name of the category that the field is available in", "type": "string" } } }, "color": { "description": "The color of the field in the app", "type": "string" }, "createdAt": { "description": "Date & time the field was created", "format": "date-time", "nullable": true, "type": "string" }, "createdBy": { "description": "Name of the user who created the field", "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "id": { "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" }, "updatedAt": { "description": "Date & time the field was last updated", "format": "date-time", "nullable": true, "type": "string" }, "updatedBy": { "description": "Name of the user who last updated the field", "type": "string" } } }, { "additionalProperties": false, "title": "Model View Field", "type": "object", "required": [ "type", "category", "createdAt", "createdBy", "description", "id", "name", "updatedAt", "updatedBy" ], "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" ] }, "category": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "description": "Name of the category that the field is available in", "type": "string" } } }, "color": { "description": "The color of the field in the app", "type": "string" }, "createdAt": { "description": "Date & time the field was created", "format": "date-time", "nullable": true, "type": "string" }, "createdBy": { "description": "Name of the user who created the field", "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "id": { "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" }, "updatedAt": { "description": "Date & time the field was last updated", "format": "date-time", "nullable": true, "type": "string" }, "updatedBy": { "description": "Name of the user who last updated the field", "type": "string" } } }, { "additionalProperties": false, "title": "Model Name Field", "type": "object", "required": [ "type", "category", "createdAt", "createdBy", "description", "id", "name", "updatedAt", "updatedBy" ], "properties": { "type": { "type": "string", "enum": [ "modelName" ] }, "category": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "description": "Name of the category that the field is available in", "type": "string" } } }, "color": { "description": "The color of the field in the app", "type": "string" }, "createdAt": { "description": "Date & time the field was created", "format": "date-time", "nullable": true, "type": "string" }, "createdBy": { "description": "Name of the user who created the field", "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "id": { "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" }, "updatedAt": { "description": "Date & time the field was last updated", "format": "date-time", "nullable": true, "type": "string" }, "updatedBy": { "description": "Name of the user who last updated the field", "type": "string" } } }, { "additionalProperties": false, "title": "Number Field", "type": "object", "required": [ "format", "type", "category", "createdAt", "createdBy", "description", "id", "name", "updatedAt", "updatedBy" ], "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" ] }, "category": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "description": "Name of the category that the field is available in", "type": "string" } } }, "color": { "description": "The color of the field in the app", "type": "string" }, "createdAt": { "description": "Date & time the field was created", "format": "date-time", "nullable": true, "type": "string" }, "createdBy": { "description": "Name of the user who created the field", "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "id": { "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" }, "updatedAt": { "description": "Date & time the field was last updated", "format": "date-time", "nullable": true, "type": "string" }, "updatedBy": { "description": "Name of the user who last updated the field", "type": "string" } } }, { "additionalProperties": false, "title": "Person Field", "type": "object", "required": [ "type", "category", "createdAt", "createdBy", "description", "id", "name", "updatedAt", "updatedBy" ], "properties": { "type": { "type": "string", "enum": [ "person" ] }, "category": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "description": "Name of the category that the field is available in", "type": "string" } } }, "color": { "description": "The color of the field in the app", "type": "string" }, "createdAt": { "description": "Date & time the field was created", "format": "date-time", "nullable": true, "type": "string" }, "createdBy": { "description": "Name of the user who created the field", "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "id": { "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" }, "updatedAt": { "description": "Date & time the field was last updated", "format": "date-time", "nullable": true, "type": "string" }, "updatedBy": { "description": "Name of the user who last updated the field", "type": "string" } } }, { "additionalProperties": false, "title": "Phone Field", "type": "object", "required": [ "type", "category", "createdAt", "createdBy", "description", "id", "name", "updatedAt", "updatedBy" ], "properties": { "placeholder": { "description": "The placeholder value for the field, displayed in the app", "maxLength": 250, "type": "string" }, "type": { "type": "string", "enum": [ "phone" ] }, "category": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "description": "Name of the category that the field is available in", "type": "string" } } }, "color": { "description": "The color of the field in the app", "type": "string" }, "createdAt": { "description": "Date & time the field was created", "format": "date-time", "nullable": true, "type": "string" }, "createdBy": { "description": "Name of the user who created the field", "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "id": { "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" }, "updatedAt": { "description": "Date & time the field was last updated", "format": "date-time", "nullable": true, "type": "string" }, "updatedBy": { "description": "Name of the user who last updated the field", "type": "string" } } }, { "additionalProperties": false, "title": "Range Field", "type": "object", "required": [ "max", "min", "step", "stepMode", "type", "category", "createdAt", "createdBy", "description", "id", "name", "updatedAt", "updatedBy" ], "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" ] }, "category": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "description": "Name of the category that the field is available in", "type": "string" } } }, "color": { "description": "The color of the field in the app", "type": "string" }, "createdAt": { "description": "Date & time the field was created", "format": "date-time", "nullable": true, "type": "string" }, "createdBy": { "description": "Name of the user who created the field", "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "id": { "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" }, "updatedAt": { "description": "Date & time the field was last updated", "format": "date-time", "nullable": true, "type": "string" }, "updatedBy": { "description": "Name of the user who last updated the field", "type": "string" } } }, { "additionalProperties": false, "title": "References Field", "type": "object", "required": [ "type", "category", "createdAt", "createdBy", "description", "id", "name", "updatedAt", "updatedBy" ], "properties": { "type": { "type": "string", "enum": [ "references" ] }, "category": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "description": "Name of the category that the field is available in", "type": "string" } } }, "color": { "description": "The color of the field in the app", "type": "string" }, "createdAt": { "description": "Date & time the field was created", "format": "date-time", "nullable": true, "type": "string" }, "createdBy": { "description": "Name of the user who created the field", "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "id": { "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" }, "updatedAt": { "description": "Date & time the field was last updated", "format": "date-time", "nullable": true, "type": "string" }, "updatedBy": { "description": "Name of the user who last updated the field", "type": "string" } } }, { "additionalProperties": false, "deprecated": true, "title": "Related Field", "type": "object", "required": [ "canCreateRelatedElement", "disableRelatedHyperlink", "type", "category", "createdAt", "createdBy", "description", "id", "name", "updatedAt", "updatedBy", "reCat" ], "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" ] }, "category": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "description": "Name of the category that the field is available in", "type": "string" } } }, "color": { "description": "The color of the field in the app", "type": "string" }, "createdAt": { "description": "Date & time the field was created", "format": "date-time", "nullable": true, "type": "string" }, "createdBy": { "description": "Name of the user who created the field", "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "id": { "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" }, "updatedAt": { "description": "Date & time the field was last updated", "format": "date-time", "nullable": true, "type": "string" }, "updatedBy": { "description": "Name of the user who last updated the field", "type": "string" }, "reCat": { "description": "The category that the autoTarget field is in", "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "description": "Name of the category that the autoTarget field is available in", "type": "string" } } }, "sibling": { "description": "For related fields, the ID of the sibling field that is kept in sync with this field", "type": "string" } } }, { "additionalProperties": false, "title": "Revit Parameters Field", "type": "object", "required": [ "paramLabels", "type", "category", "createdAt", "createdBy", "description", "id", "name", "updatedAt", "updatedBy", "param" ], "properties": { "paramLabels": { "description": "If the parameter labels are displayed", "enum": [ "show_labels", "hide_labels" ], "type": "string" }, "type": { "type": "string", "enum": [ "revitParam" ] }, "category": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "description": "Name of the category that the field is available in", "type": "string" } } }, "color": { "description": "The color of the field in the app", "type": "string" }, "createdAt": { "description": "Date & time the field was created", "format": "date-time", "nullable": true, "type": "string" }, "createdBy": { "description": "Name of the user who created the field", "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "id": { "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" }, "updatedAt": { "description": "Date & time the field was last updated", "format": "date-time", "nullable": true, "type": "string" }, "updatedBy": { "description": "Name of the user who last updated the field", "type": "string" }, "param": { "description": "The Revit parameters that are displayed in the field", "type": "array", "items": { "type": "object", "required": [ "id", "name", "type" ], "properties": { "group": { "type": "string" }, "hasScalar": { "type": "boolean" }, "id": { "type": "string" }, "name": { "type": "string" }, "type": { "enum": [ "Instance", "Type", "Forge" ], "type": "string" } } } } } }, { "additionalProperties": false, "title": "Select Field", "type": "object", "required": [ "options", "type", "category", "createdAt", "createdBy", "description", "id", "name", "updatedAt", "updatedBy" ], "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" ] }, "category": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "description": "Name of the category that the field is available in", "type": "string" } } }, "color": { "description": "The color of the field in the app", "type": "string" }, "createdAt": { "description": "Date & time the field was created", "format": "date-time", "nullable": true, "type": "string" }, "createdBy": { "description": "Name of the user who created the field", "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "id": { "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" }, "updatedAt": { "description": "Date & time the field was last updated", "format": "date-time", "nullable": true, "type": "string" }, "updatedBy": { "description": "Name of the user who last updated the field", "type": "string" } } }, { "additionalProperties": false, "title": "Spatial Relationships Field", "type": "object", "required": [ "type", "category", "createdAt", "createdBy", "description", "id", "name", "updatedAt", "updatedBy" ], "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" ] }, "category": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "description": "Name of the category that the field is available in", "type": "string" } } }, "color": { "description": "The color of the field in the app", "type": "string" }, "createdAt": { "description": "Date & time the field was created", "format": "date-time", "nullable": true, "type": "string" }, "createdBy": { "description": "Name of the user who created the field", "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "id": { "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" }, "updatedAt": { "description": "Date & time the field was last updated", "format": "date-time", "nullable": true, "type": "string" }, "updatedBy": { "description": "Name of the user who last updated the field", "type": "string" } } }, { "additionalProperties": false, "title": "Text Field", "type": "object", "required": [ "type", "category", "createdAt", "createdBy", "description", "id", "name", "updatedAt", "updatedBy" ], "properties": { "placeholder": { "description": "The placeholder value for the field, displayed in the app", "maxLength": 250, "type": "string" }, "type": { "type": "string", "enum": [ "text" ] }, "category": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "description": "Name of the category that the field is available in", "type": "string" } } }, "color": { "description": "The color of the field in the app", "type": "string" }, "createdAt": { "description": "Date & time the field was created", "format": "date-time", "nullable": true, "type": "string" }, "createdBy": { "description": "Name of the user who created the field", "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "id": { "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" }, "updatedAt": { "description": "Date & time the field was last updated", "format": "date-time", "nullable": true, "type": "string" }, "updatedBy": { "description": "Name of the user who last updated the field", "type": "string" } } }, { "additionalProperties": false, "title": "Toggle Field", "type": "object", "required": [ "type", "category", "createdAt", "createdBy", "description", "id", "name", "updatedAt", "updatedBy" ], "properties": { "type": { "type": "string", "enum": [ "toggle" ] }, "category": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "description": "Name of the category that the field is available in", "type": "string" } } }, "color": { "description": "The color of the field in the app", "type": "string" }, "createdAt": { "description": "Date & time the field was created", "format": "date-time", "nullable": true, "type": "string" }, "createdBy": { "description": "Name of the user who created the field", "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "id": { "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" }, "updatedAt": { "description": "Date & time the field was last updated", "format": "date-time", "nullable": true, "type": "string" }, "updatedBy": { "description": "Name of the user who last updated the field", "type": "string" } } }, { "additionalProperties": false, "title": "Updated At Field", "type": "object", "required": [ "type", "category", "createdAt", "createdBy", "description", "id", "name", "updatedAt", "updatedBy" ], "properties": { "type": { "type": "string", "enum": [ "updatedat" ] }, "category": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "description": "Name of the category that the field is available in", "type": "string" } } }, "color": { "description": "The color of the field in the app", "type": "string" }, "createdAt": { "description": "Date & time the field was created", "format": "date-time", "nullable": true, "type": "string" }, "createdBy": { "description": "Name of the user who created the field", "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "id": { "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" }, "updatedAt": { "description": "Date & time the field was last updated", "format": "date-time", "nullable": true, "type": "string" }, "updatedBy": { "description": "Name of the user who last updated the field", "type": "string" } } }, { "additionalProperties": false, "title": "Updated By Field", "type": "object", "required": [ "type", "category", "createdAt", "createdBy", "description", "id", "name", "updatedAt", "updatedBy" ], "properties": { "type": { "type": "string", "enum": [ "updatedby" ] }, "category": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "description": "Name of the category that the field is available in", "type": "string" } } }, "color": { "description": "The color of the field in the app", "type": "string" }, "createdAt": { "description": "Date & time the field was created", "format": "date-time", "nullable": true, "type": "string" }, "createdBy": { "description": "Name of the user who created the field", "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "id": { "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" }, "updatedAt": { "description": "Date & time the field was last updated", "format": "date-time", "nullable": true, "type": "string" }, "updatedBy": { "description": "Name of the user who last updated the field", "type": "string" } } }, { "additionalProperties": false, "title": "Model Version History Field", "type": "object", "required": [ "type", "category", "createdAt", "createdBy", "description", "id", "name", "updatedAt", "updatedBy" ], "properties": { "type": { "type": "string", "enum": [ "versionHistory" ] }, "category": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "description": "Name of the category that the field is available in", "type": "string" } } }, "color": { "description": "The color of the field in the app", "type": "string" }, "createdAt": { "description": "Date & time the field was created", "format": "date-time", "nullable": true, "type": "string" }, "createdBy": { "description": "Name of the user who created the field", "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "id": { "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" }, "updatedAt": { "description": "Date & time the field was last updated", "format": "date-time", "nullable": true, "type": "string" }, "updatedBy": { "description": "Name of the user who last updated the field", "type": "string" } } }, { "additionalProperties": false, "title": "Manual Related Field", "type": "object", "required": [ "type", "relationType", "category", "createdAt", "createdBy", "description", "id", "name", "updatedAt", "updatedBy", "reCat" ], "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" } } } }, "type": { "type": "string", "enum": [ "relatedV2" ] }, "multiple": { "description": "If multiple related objects can be selected", "type": "boolean" }, "relationType": { "type": "string", "enum": [ "manual" ] }, "trackQuantity": { "description": "If the quantity of the objects in the field are tracked", "type": "boolean" }, "category": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "description": "Name of the category that the field is available in", "type": "string" } } }, "color": { "description": "The color of the field in the app", "type": "string" }, "createdAt": { "description": "Date & time the field was created", "format": "date-time", "nullable": true, "type": "string" }, "createdBy": { "description": "Name of the user who created the field", "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "id": { "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" }, "updatedAt": { "description": "Date & time the field was last updated", "format": "date-time", "nullable": true, "type": "string" }, "updatedBy": { "description": "Name of the user who last updated the field", "type": "string" }, "reCat": { "description": "The category that the related field points to", "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "description": "Name of the category that the related field points to", "type": "string" } } }, "sibling": { "description": "The ID of the manual related sibling field that is kept in sync with this field", "type": "string" } } }, { "additionalProperties": false, "title": "Automatic Related Field", "type": "object", "required": [ "type", "relationType", "category", "createdAt", "createdBy", "description", "id", "name", "updatedAt", "updatedBy", "reCat", "relatedMatchConfig" ], "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" } } } }, "type": { "type": "string", "enum": [ "relatedV2" ] }, "relationType": { "type": "string", "enum": [ "automatic" ] }, "category": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "description": "Name of the category that the field is available in", "type": "string" } } }, "color": { "description": "The color of the field in the app", "type": "string" }, "createdAt": { "description": "Date & time the field was created", "format": "date-time", "nullable": true, "type": "string" }, "createdBy": { "description": "Name of the user who created the field", "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "id": { "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" }, "updatedAt": { "description": "Date & time the field was last updated", "format": "date-time", "nullable": true, "type": "string" }, "updatedBy": { "description": "Name of the user who last updated the field", "type": "string" }, "reCat": { "description": "The category that the related field points to", "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "description": "Name of the category that the related field points to", "type": "string" } } }, "relatedMatchConfig": { "type": "object", "required": [ "logicalOperator", "matchConditions" ], "properties": { "logicalOperator": { "anyOf": [ { "type": "string", "enum": [ "AND" ] }, { "type": "string", "enum": [ "OR" ] } ] }, "matchConditions": { "type": "array", "items": { "type": "object", "required": [ "clause", "matchValue", "relatedValue" ], "properties": { "clause": { "anyOf": [ { "type": "string", "enum": [ "BOOL_IS" ] }, { "type": "string", "enum": [ "BOOL_IS_NOT" ] }, { "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" ] }, { "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" ] }, { "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" ] }, { "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" ] } ] }, "matchValue": { "anyOf": [ { "anyOf": [ { "type": "object", "required": [ "fieldType", "type", "value" ], "properties": { "fieldType": { "anyOf": [ { "type": "string", "enum": [ "area" ] }, { "type": "string", "enum": [ "barcode" ] }, { "type": "string", "enum": [ "createdat" ] }, { "type": "string", "enum": [ "createdby" ] }, { "type": "string", "enum": [ "date" ] }, { "type": "string", "enum": [ "elementNumber" ] }, { "type": "string", "enum": [ "email" ] }, { "type": "string", "enum": [ "file" ] }, { "type": "string", "enum": [ "formulaV2" ] }, { "type": "string", "enum": [ "modelName" ] }, { "type": "string", "enum": [ "number" ] }, { "type": "string", "enum": [ "person" ] }, { "type": "string", "enum": [ "phone" ] }, { "type": "string", "enum": [ "range" ] }, { "type": "string", "enum": [ "references" ] }, { "type": "string", "enum": [ "related" ] }, { "type": "string", "enum": [ "relatedV2" ] }, { "type": "string", "enum": [ "revitParam" ] }, { "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" ] } ] }, "type": { "type": "string", "enum": [ "field" ] }, "value": { "type": "string" } } }, { "type": "object", "required": [ "fieldType", "type", "value" ], "properties": { "fieldType": { "anyOf": [ { "type": "string", "enum": [ "area" ] }, { "type": "string", "enum": [ "barcode" ] }, { "type": "string", "enum": [ "createdat" ] }, { "type": "string", "enum": [ "createdby" ] }, { "type": "string", "enum": [ "date" ] }, { "type": "string", "enum": [ "elementNumber" ] }, { "type": "string", "enum": [ "email" ] }, { "type": "string", "enum": [ "file" ] }, { "type": "string", "enum": [ "formulaV2" ] }, { "type": "string", "enum": [ "modelName" ] }, { "type": "string", "enum": [ "number" ] }, { "type": "string", "enum": [ "person" ] }, { "type": "string", "enum": [ "phone" ] }, { "type": "string", "enum": [ "range" ] }, { "type": "string", "enum": [ "references" ] }, { "type": "string", "enum": [ "related" ] }, { "type": "string", "enum": [ "relatedV2" ] }, { "type": "string", "enum": [ "revitParam" ] }, { "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" ] } ] }, "type": { "type": "string", "enum": [ "metadata" ] }, "value": { "anyOf": [ { "type": "string", "enum": [ "completed" ] }, { "type": "string", "enum": [ "createdAt" ] }, { "type": "string", "enum": [ "createdBy" ] }, { "type": "string", "enum": [ "name" ] }, { "type": "string", "enum": [ "starred" ] }, { "type": "string", "enum": [ "updatedAt" ] }, { "type": "string", "enum": [ "updatedBy" ] }, { "type": "string", "enum": [ "elementNumber" ] } ] } } }, { "type": "object", "required": [ "fieldType", "type", "value" ], "properties": { "fieldType": { "anyOf": [ { "type": "string", "enum": [ "area" ] }, { "type": "string", "enum": [ "barcode" ] }, { "type": "string", "enum": [ "createdat" ] }, { "type": "string", "enum": [ "createdby" ] }, { "type": "string", "enum": [ "date" ] }, { "type": "string", "enum": [ "elementNumber" ] }, { "type": "string", "enum": [ "email" ] }, { "type": "string", "enum": [ "file" ] }, { "type": "string", "enum": [ "formulaV2" ] }, { "type": "string", "enum": [ "modelName" ] }, { "type": "string", "enum": [ "number" ] }, { "type": "string", "enum": [ "person" ] }, { "type": "string", "enum": [ "phone" ] }, { "type": "string", "enum": [ "range" ] }, { "type": "string", "enum": [ "references" ] }, { "type": "string", "enum": [ "related" ] }, { "type": "string", "enum": [ "relatedV2" ] }, { "type": "string", "enum": [ "revitParam" ] }, { "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" ] } ] }, "type": { "type": "string", "enum": [ "revitParam" ] }, "value": { "anyOf": [ { "type": "string", "enum": [ "family" ] }, { "type": "string", "enum": [ "modelRevitId" ] }, { "type": "string", "enum": [ "createdPhaseId" ] }, { "type": "string", "enum": [ "type" ] }, { "type": "string" } ] } } }, { "type": "object", "required": [ "fieldType", "mapTo", "type", "value" ], "properties": { "fieldType": { "type": "string", "enum": [ "select" ] }, "mapTo": { "anyOf": [ { "type": "string", "enum": [ "id" ] }, { "type": "string", "enum": [ "value" ] }, { "type": "string", "enum": [ "label" ] } ] }, "type": { "type": "string", "enum": [ "field" ] }, "value": { "type": "string" } } }, { "type": "object", "required": [ "fieldType", "type", "value" ], "properties": { "categoryId": { "anyOf": [ { "type": "string" } ] }, "fieldType": { "type": "string", "enum": [ "spatialRelationships" ] }, "type": { "type": "string", "enum": [ "field" ] }, "value": { "type": "string" } } } ] }, { "type": "object", "required": [ "type", "value" ], "properties": { "type": { "type": "string", "enum": [ "dynamic" ] }, "value": { "anyOf": [ { "type": "string", "enum": [ "currentUser" ] }, { "type": "array", "items": { "anyOf": [ { "type": "string", "enum": [ "currentUser" ] }, { "type": "string" } ] } }, { "type": "object", "required": [ "config", "type" ], "properties": { "config": { "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": { "type": "string", "enum": [ "relativeDate" ] } } } ] } } }, { "type": "object", "required": [ "type", "value" ], "properties": { "type": { "type": "string", "enum": [ "static" ] }, "value": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } } }, { "type": "object", "required": [ "type", "value" ], "properties": { "type": { "type": "string", "enum": [ "empty" ] } } } ] }, "relatedValue": { "anyOf": [ { "anyOf": [ { "type": "object", "required": [ "fieldType", "type", "value" ], "properties": { "fieldType": { "anyOf": [ { "type": "string", "enum": [ "area" ] }, { "type": "string", "enum": [ "barcode" ] }, { "type": "string", "enum": [ "createdat" ] }, { "type": "string", "enum": [ "createdby" ] }, { "type": "string", "enum": [ "date" ] }, { "type": "string", "enum": [ "elementNumber" ] }, { "type": "string", "enum": [ "email" ] }, { "type": "string", "enum": [ "file" ] }, { "type": "string", "enum": [ "formulaV2" ] }, { "type": "string", "enum": [ "modelName" ] }, { "type": "string", "enum": [ "number" ] }, { "type": "string", "enum": [ "person" ] }, { "type": "string", "enum": [ "phone" ] }, { "type": "string", "enum": [ "range" ] }, { "type": "string", "enum": [ "references" ] }, { "type": "string", "enum": [ "related" ] }, { "type": "string", "enum": [ "relatedV2" ] }, { "type": "string", "enum": [ "revitParam" ] }, { "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" ] } ] }, "type": { "type": "string", "enum": [ "field" ] }, "value": { "type": "string" } } }, { "type": "object", "required": [ "fieldType", "type", "value" ], "properties": { "fieldType": { "anyOf": [ { "type": "string", "enum": [ "area" ] }, { "type": "string", "enum": [ "barcode" ] }, { "type": "string", "enum": [ "createdat" ] }, { "type": "string", "enum": [ "createdby" ] }, { "type": "string", "enum": [ "date" ] }, { "type": "string", "enum": [ "elementNumber" ] }, { "type": "string", "enum": [ "email" ] }, { "type": "string", "enum": [ "file" ] }, { "type": "string", "enum": [ "formulaV2" ] }, { "type": "string", "enum": [ "modelName" ] }, { "type": "string", "enum": [ "number" ] }, { "type": "string", "enum": [ "person" ] }, { "type": "string", "enum": [ "phone" ] }, { "type": "string", "enum": [ "range" ] }, { "type": "string", "enum": [ "references" ] }, { "type": "string", "enum": [ "related" ] }, { "type": "string", "enum": [ "relatedV2" ] }, { "type": "string", "enum": [ "revitParam" ] }, { "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" ] } ] }, "type": { "type": "string", "enum": [ "metadata" ] }, "value": { "anyOf": [ { "type": "string", "enum": [ "completed" ] }, { "type": "string", "enum": [ "createdAt" ] }, { "type": "string", "enum": [ "createdBy" ] }, { "type": "string", "enum": [ "name" ] }, { "type": "string", "enum": [ "starred" ] }, { "type": "string", "enum": [ "updatedAt" ] }, { "type": "string", "enum": [ "updatedBy" ] }, { "type": "string", "enum": [ "elementNumber" ] } ] } } }, { "type": "object", "required": [ "fieldType", "type", "value" ], "properties": { "fieldType": { "anyOf": [ { "type": "string", "enum": [ "area" ] }, { "type": "string", "enum": [ "barcode" ] }, { "type": "string", "enum": [ "createdat" ] }, { "type": "string", "enum": [ "createdby" ] }, { "type": "string", "enum": [ "date" ] }, { "type": "string", "enum": [ "elementNumber" ] }, { "type": "string", "enum": [ "email" ] }, { "type": "string", "enum": [ "file" ] }, { "type": "string", "enum": [ "formulaV2" ] }, { "type": "string", "enum": [ "modelName" ] }, { "type": "string", "enum": [ "number" ] }, { "type": "string", "enum": [ "person" ] }, { "type": "string", "enum": [ "phone" ] }, { "type": "string", "enum": [ "range" ] }, { "type": "string", "enum": [ "references" ] }, { "type": "string", "enum": [ "related" ] }, { "type": "string", "enum": [ "relatedV2" ] }, { "type": "string", "enum": [ "revitParam" ] }, { "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" ] } ] }, "type": { "type": "string", "enum": [ "revitParam" ] }, "value": { "anyOf": [ { "type": "string", "enum": [ "family" ] }, { "type": "string", "enum": [ "modelRevitId" ] }, { "type": "string", "enum": [ "createdPhaseId" ] }, { "type": "string", "enum": [ "type" ] }, { "type": "string" } ] } } }, { "type": "object", "required": [ "fieldType", "mapTo", "type", "value" ], "properties": { "fieldType": { "type": "string", "enum": [ "select" ] }, "mapTo": { "anyOf": [ { "type": "string", "enum": [ "id" ] }, { "type": "string", "enum": [ "value" ] }, { "type": "string", "enum": [ "label" ] } ] }, "type": { "type": "string", "enum": [ "field" ] }, "value": { "type": "string" } } }, { "type": "object", "required": [ "fieldType", "type", "value" ], "properties": { "categoryId": { "anyOf": [ { "type": "string" } ] }, "fieldType": { "type": "string", "enum": [ "spatialRelationships" ] }, "type": { "type": "string", "enum": [ "field" ] }, "value": { "type": "string" } } } ] }, { "type": "object", "required": [ "type", "value" ], "properties": { "type": { "type": "string", "enum": [ "dynamic" ] }, "value": { "anyOf": [ { "type": "string", "enum": [ "currentUser" ] }, { "type": "array", "items": { "anyOf": [ { "type": "string", "enum": [ "currentUser" ] }, { "type": "string" } ] } }, { "type": "object", "required": [ "config", "type" ], "properties": { "config": { "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": { "type": "string", "enum": [ "relativeDate" ] } } } ] } } }, { "type": "object", "required": [ "type", "value" ], "properties": { "type": { "type": "string", "enum": [ "static" ] }, "value": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } } }, { "type": "object", "required": [ "type", "value" ], "properties": { "type": { "type": "string", "enum": [ "empty" ] } } } ] } } } } } } } }, { "additionalProperties": false, "title": "Spatial Related Field", "type": "object", "required": [ "type", "relationType", "category", "createdAt", "createdBy", "description", "id", "name", "updatedAt", "updatedBy", "reCat", "relatedMatchConfig" ], "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" } } } }, "type": { "type": "string", "enum": [ "relatedV2" ] }, "relationType": { "type": "string", "enum": [ "spatial" ] }, "category": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "description": "Name of the category that the field is available in", "type": "string" } } }, "color": { "description": "The color of the field in the app", "type": "string" }, "createdAt": { "description": "Date & time the field was created", "format": "date-time", "nullable": true, "type": "string" }, "createdBy": { "description": "Name of the user who created the field", "type": "string" }, "description": { "description": "Description of the field", "type": "string" }, "id": { "type": "string" }, "name": { "description": "Name of the field", "maxLength": 255, "type": "string" }, "updatedAt": { "description": "Date & time the field was last updated", "format": "date-time", "nullable": true, "type": "string" }, "updatedBy": { "description": "Name of the user who last updated the field", "type": "string" }, "reCat": { "description": "The category that the related field points to", "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "description": "Name of the category that the related field points to", "type": "string" } } }, "relatedMatchConfig": { "type": "object", "required": [ "logicalOperator", "matchConditions" ], "properties": { "logicalOperator": { "anyOf": [ { "type": "string", "enum": [ "AND" ] }, { "type": "string", "enum": [ "OR" ] } ] }, "matchConditions": { "type": "array", "items": { "type": "object", "required": [ "clause", "matchValue", "relatedValue" ], "properties": { "clause": { "anyOf": [ { "type": "string", "enum": [ "BOOL_IS" ] }, { "type": "string", "enum": [ "BOOL_IS_NOT" ] }, { "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" ] }, { "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" ] }, { "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" ] }, { "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" ] } ] }, "matchValue": { "anyOf": [ { "anyOf": [ { "type": "object", "required": [ "fieldType", "type", "value" ], "properties": { "fieldType": { "anyOf": [ { "type": "string", "enum": [ "area" ] }, { "type": "string", "enum": [ "barcode" ] }, { "type": "string", "enum": [ "createdat" ] }, { "type": "string", "enum": [ "createdby" ] }, { "type": "string", "enum": [ "date" ] }, { "type": "string", "enum": [ "elementNumber" ] }, { "type": "string", "enum": [ "email" ] }, { "type": "string", "enum": [ "file" ] }, { "type": "string", "enum": [ "formulaV2" ] }, { "type": "string", "enum": [ "modelName" ] }, { "type": "string", "enum": [ "number" ] }, { "type": "string", "enum": [ "person" ] }, { "type": "string", "enum": [ "phone" ] }, { "type": "string", "enum": [ "range" ] }, { "type": "string", "enum": [ "references" ] }, { "type": "string", "enum": [ "related" ] }, { "type": "string", "enum": [ "relatedV2" ] }, { "type": "string", "enum": [ "revitParam" ] }, { "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" ] } ] }, "type": { "type": "string", "enum": [ "field" ] }, "value": { "type": "string" } } }, { "type": "object", "required": [ "fieldType", "type", "value" ], "properties": { "fieldType": { "anyOf": [ { "type": "string", "enum": [ "area" ] }, { "type": "string", "enum": [ "barcode" ] }, { "type": "string", "enum": [ "createdat" ] }, { "type": "string", "enum": [ "createdby" ] }, { "type": "string", "enum": [ "date" ] }, { "type": "string", "enum": [ "elementNumber" ] }, { "type": "string", "enum": [ "email" ] }, { "type": "string", "enum": [ "file" ] }, { "type": "string", "enum": [ "formulaV2" ] }, { "type": "string", "enum": [ "modelName" ] }, { "type": "string", "enum": [ "number" ] }, { "type": "string", "enum": [ "person" ] }, { "type": "string", "enum": [ "phone" ] }, { "type": "string", "enum": [ "range" ] }, { "type": "string", "enum": [ "references" ] }, { "type": "string", "enum": [ "related" ] }, { "type": "string", "enum": [ "relatedV2" ] }, { "type": "string", "enum": [ "revitParam" ] }, { "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" ] } ] }, "type": { "type": "string", "enum": [ "metadata" ] }, "value": { "anyOf": [ { "type": "string", "enum": [ "completed" ] }, { "type": "string", "enum": [ "createdAt" ] }, { "type": "string", "enum": [ "createdBy" ] }, { "type": "string", "enum": [ "name" ] }, { "type": "string", "enum": [ "starred" ] }, { "type": "string", "enum": [ "updatedAt" ] }, { "type": "string", "enum": [ "updatedBy" ] }, { "type": "string", "enum": [ "elementNumber" ] } ] } } }, { "type": "object", "required": [ "fieldType", "type", "value" ], "properties": { "fieldType": { "anyOf": [ { "type": "string", "enum": [ "area" ] }, { "type": "string", "enum": [ "barcode" ] }, { "type": "string", "enum": [ "createdat" ] }, { "type": "string", "enum": [ "createdby" ] }, { "type": "string", "enum": [ "date" ] }, { "type": "string", "enum": [ "elementNumber" ] }, { "type": "string", "enum": [ "email" ] }, { "type": "string", "enum": [ "file" ] }, { "type": "string", "enum": [ "formulaV2" ] }, { "type": "string", "enum": [ "modelName" ] }, { "type": "string", "enum": [ "number" ] }, { "type": "string", "enum": [ "person" ] }, { "type": "string", "enum": [ "phone" ] }, { "type": "string", "enum": [ "range" ] }, { "type": "string", "enum": [ "references" ] }, { "type": "string", "enum": [ "related" ] }, { "type": "string", "enum": [ "relatedV2" ] }, { "type": "string", "enum": [ "revitParam" ] }, { "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" ] } ] }, "type": { "type": "string", "enum": [ "revitParam" ] }, "value": { "anyOf": [ { "type": "string", "enum": [ "family" ] }, { "type": "string", "enum": [ "modelRevitId" ] }, { "type": "string", "enum": [ "createdPhaseId" ] }, { "type": "string", "enum": [ "type" ] }, { "type": "string" } ] } } }, { "type": "object", "required": [ "fieldType", "mapTo", "type", "value" ], "properties": { "fieldType": { "type": "string", "enum": [ "select" ] }, "mapTo": { "anyOf": [ { "type": "string", "enum": [ "id" ] }, { "type": "string", "enum": [ "value" ] }, { "type": "string", "enum": [ "label" ] } ] }, "type": { "type": "string", "enum": [ "field" ] }, "value": { "type": "string" } } }, { "type": "object", "required": [ "fieldType", "type", "value" ], "properties": { "categoryId": { "anyOf": [ { "type": "string" } ] }, "fieldType": { "type": "string", "enum": [ "spatialRelationships" ] }, "type": { "type": "string", "enum": [ "field" ] }, "value": { "type": "string" } } } ] }, { "type": "object", "required": [ "type", "value" ], "properties": { "type": { "type": "string", "enum": [ "dynamic" ] }, "value": { "anyOf": [ { "type": "string", "enum": [ "currentUser" ] }, { "type": "array", "items": { "anyOf": [ { "type": "string", "enum": [ "currentUser" ] }, { "type": "string" } ] } }, { "type": "object", "required": [ "config", "type" ], "properties": { "config": { "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": { "type": "string", "enum": [ "relativeDate" ] } } } ] } } }, { "type": "object", "required": [ "type", "value" ], "properties": { "type": { "type": "string", "enum": [ "static" ] }, "value": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } } }, { "type": "object", "required": [ "type", "value" ], "properties": { "type": { "type": "string", "enum": [ "empty" ] } } } ] }, "relatedValue": { "anyOf": [ { "anyOf": [ { "type": "object", "required": [ "fieldType", "type", "value" ], "properties": { "fieldType": { "anyOf": [ { "type": "string", "enum": [ "area" ] }, { "type": "string", "enum": [ "barcode" ] }, { "type": "string", "enum": [ "createdat" ] }, { "type": "string", "enum": [ "createdby" ] }, { "type": "string", "enum": [ "date" ] }, { "type": "string", "enum": [ "elementNumber" ] }, { "type": "string", "enum": [ "email" ] }, { "type": "string", "enum": [ "file" ] }, { "type": "string", "enum": [ "formulaV2" ] }, { "type": "string", "enum": [ "modelName" ] }, { "type": "string", "enum": [ "number" ] }, { "type": "string", "enum": [ "person" ] }, { "type": "string", "enum": [ "phone" ] }, { "type": "string", "enum": [ "range" ] }, { "type": "string", "enum": [ "references" ] }, { "type": "string", "enum": [ "related" ] }, { "type": "string", "enum": [ "relatedV2" ] }, { "type": "string", "enum": [ "revitParam" ] }, { "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" ] } ] }, "type": { "type": "string", "enum": [ "field" ] }, "value": { "type": "string" } } }, { "type": "object", "required": [ "fieldType", "type", "value" ], "properties": { "fieldType": { "anyOf": [ { "type": "string", "enum": [ "area" ] }, { "type": "string", "enum": [ "barcode" ] }, { "type": "string", "enum": [ "createdat" ] }, { "type": "string", "enum": [ "createdby" ] }, { "type": "string", "enum": [ "date" ] }, { "type": "string", "enum": [ "elementNumber" ] }, { "type": "string", "enum": [ "email" ] }, { "type": "string", "enum": [ "file" ] }, { "type": "string", "enum": [ "formulaV2" ] }, { "type": "string", "enum": [ "modelName" ] }, { "type": "string", "enum": [ "number" ] }, { "type": "string", "enum": [ "person" ] }, { "type": "string", "enum": [ "phone" ] }, { "type": "string", "enum": [ "range" ] }, { "type": "string", "enum": [ "references" ] }, { "type": "string", "enum": [ "related" ] }, { "type": "string", "enum": [ "relatedV2" ] }, { "type": "string", "enum": [ "revitParam" ] }, { "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" ] } ] }, "type": { "type": "string", "enum": [ "metadata" ] }, "value": { "anyOf": [ { "type": "string", "enum": [ "completed" ] }, { "type": "string", "enum": [ "createdAt" ] }, { "type": "string", "enum": [ "createdBy" ] }, { "type": "string", "enum": [ "name" ] }, { "type": "string", "enum": [ "starred" ] }, { "type": "string", "enum": [ "updatedAt" ] }, { "type": "string", "enum": [ "updatedBy" ] }, { "type": "string", "enum": [ "elementNumber" ] } ] } } }, { "type": "object", "required": [ "fieldType", "type", "value" ], "properties": { "fieldType": { "anyOf": [ { "type": "string", "enum": [ "area" ] }, { "type": "string", "enum": [ "barcode" ] }, { "type": "string", "enum": [ "createdat" ] }, { "type": "string", "enum": [ "createdby" ] }, { "type": "string", "enum": [ "date" ] }, { "type": "string", "enum": [ "elementNumber" ] }, { "type": "string", "enum": [ "email" ] }, { "type": "string", "enum": [ "file" ] }, { "type": "string", "enum": [ "formulaV2" ] }, { "type": "string", "enum": [ "modelName" ] }, { "type": "string", "enum": [ "number" ] }, { "type": "string", "enum": [ "person" ] }, { "type": "string", "enum": [ "phone" ] }, { "type": "string", "enum": [ "range" ] }, { "type": "string", "enum": [ "references" ] }, { "type": "string", "enum": [ "related" ] }, { "type": "string", "enum": [ "relatedV2" ] }, { "type": "string", "enum": [ "revitParam" ] }, { "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" ] } ] }, "type": { "type": "string", "enum": [ "revitParam" ] }, "value": { "anyOf": [ { "type": "string", "enum": [ "family" ] }, { "type": "string", "enum": [ "modelRevitId" ] }, { "type": "string", "enum": [ "createdPhaseId" ] }, { "type": "string", "enum": [ "type" ] }, { "type": "string" } ] } } }, { "type": "object", "required": [ "fieldType", "mapTo", "type", "value" ], "properties": { "fieldType": { "type": "string", "enum": [ "select" ] }, "mapTo": { "anyOf": [ { "type": "string", "enum": [ "id" ] }, { "type": "string", "enum": [ "value" ] }, { "type": "string", "enum": [ "label" ] } ] }, "type": { "type": "string", "enum": [ "field" ] }, "value": { "type": "string" } } }, { "type": "object", "required": [ "fieldType", "type", "value" ], "properties": { "categoryId": { "anyOf": [ { "type": "string" } ] }, "fieldType": { "type": "string", "enum": [ "spatialRelationships" ] }, "type": { "type": "string", "enum": [ "field" ] }, "value": { "type": "string" } } } ] }, { "type": "object", "required": [ "type", "value" ], "properties": { "type": { "type": "string", "enum": [ "dynamic" ] }, "value": { "anyOf": [ { "type": "string", "enum": [ "currentUser" ] }, { "type": "array", "items": { "anyOf": [ { "type": "string", "enum": [ "currentUser" ] }, { "type": "string" } ] } }, { "type": "object", "required": [ "config", "type" ], "properties": { "config": { "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": { "type": "string", "enum": [ "relativeDate" ] } } } ] } } }, { "type": "object", "required": [ "type", "value" ], "properties": { "type": { "type": "string", "enum": [ "static" ] }, "value": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } } }, { "type": "object", "required": [ "type", "value" ], "properties": { "type": { "type": "string", "enum": [ "empty" ] } } } ] } } } } } } } } ] } }, "total": { "description": "Total number of fields in the response", "type": "number" }, "view": { "description": "Summary information about the view associated with these fields (if a viewId is provided)", "type": "object", "required": [ "name", "type" ], "properties": { "name": { "description": "Name of the category view", "type": "string" }, "type": { "description": "View type", "enum": [ "DOCUMENT", "DRAWING", "FORM", "GALLERY", "MODEL", "TABLE" ], "type": "string" } } } } } } } }, "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" ] } } ```