{"openapi":"3.1.0","info":{"title":"i3X API Beta","description":"Industrial Information Interface eXchange API - 1.0 Beta","version":"beta"},"servers":[{"url":"/v1"}],"paths":{"/info":{"get":{"tags":["Info"],"summary":"Server Info","description":"Returns the server version and capabilities. May be used as a health check.\nThis endpoint does not require authentication.","operationId":"getInfo","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse_ServerInfo_"}}}},"default":{"description":"Error — see error.code for the HTTP status code (400, 401, 403, 404, 500, etc.)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/namespaces":{"get":{"tags":["Explore"],"summary":"Get Namespaces","description":"Get all Namespaces","operationId":"getNamespaces","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse_List_Namespace__"}}}},"default":{"description":"Error — see error.code for the HTTP status code (400, 401, 403, 404, 500, etc.)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/objecttypes":{"get":{"tags":["Explore"],"summary":"Get Object Types","description":"Get the schemas for all Types. Optionally filter by Namespace","operationId":"getObjectTypes","parameters":[{"name":"namespaceUri","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Namespaceuri"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse_List_ObjectTypeResponse__"}}}},"default":{"description":"Error — see error.code for the HTTP status code (400, 401, 403, 404, 500, etc.)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/objecttypes/query":{"post":{"tags":["Explore"],"summary":"Query Object Types by ElementId","description":"Get the schema for one or more Types by ElementID.\n\nRequest body: {\"elementIds\": [\"...\", \"...\"]}\n\nReturns bulk response with succeeded/failed.","operationId":"queryObjectTypesById","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetObjectTypesRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkResponse_ObjectTypeResponse_"}}}},"default":{"description":"Error — see error.code for the HTTP status code (400, 401, 403, 404, 500, etc.)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/relationshiptypes":{"get":{"tags":["Explore"],"summary":"Get Relationship Types","description":"Get all Relationship Types. Optionally filtered by Namespace","operationId":"getRelationshipTypes","parameters":[{"name":"namespaceUri","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Namespaceuri"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse_List_RelationshipType__"}}}},"default":{"description":"Error — see error.code for the HTTP status code (400, 401, 403, 404, 500, etc.)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/relationshiptypes/query":{"post":{"tags":["Explore"],"summary":"Query Relationship Types by ElementId","description":"Get one or more Relationship Types by ElementID.\n\nRequest body: {\"elementIds\": [\"...\", \"...\"]}\n\nReturns bulk response with succeeded/failed.","operationId":"queryRelationshipTypesById","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRelationshipTypesRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkResponse_RelationshipType_"}}}},"default":{"description":"Error — see error.code for the HTTP status code (400, 401, 403, 404, 500, etc.)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/objects":{"get":{"tags":["Explore"],"summary":"Get Objects","description":"Return all Objects. Optionally filter by typeElementId or set root=true to get root Objects.","operationId":"getObjects","parameters":[{"name":"typeElementId","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Typeelementid"}},{"name":"includeMetadata","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Includemetadata"}},{"name":"root","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Root"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse_List_ObjectInstanceResponse__"}}}},"default":{"description":"Error — see error.code for the HTTP status code (400, 401, 403, 404, 500, etc.)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/objects/list":{"post":{"tags":["Explore"],"summary":"List Objects by ElementId","description":"Return one or more Objects by elementId.\n\nRequest body: {\"elementIds\": [\"...\", \"...\"]}\n\nReturns bulk response with succeeded/failed.","operationId":"listObjectsById","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetObjectsRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkResponse_ObjectInstanceResponse_"}}}},"default":{"description":"Error — see error.code for the HTTP status code (400, 401, 403, 404, 500, etc.)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/objects/related":{"post":{"tags":["Explore"],"summary":"Query Related Objects","description":"Return related objects for one or more elementIds.\n\nRequest body: {\"elementIds\": [\"...\", \"...\"]}\n\nReturns bulk response with succeeded/failed.","operationId":"queryRelatedObjects","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRelatedObjectsRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkResponse_List_RelatedObjectResult__"}}}},"default":{"description":"Error — see error.code for the HTTP status code (400, 401, 403, 404, 500, etc.)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/objects/value":{"post":{"tags":["Query"],"summary":"Query Last Known Values","description":"Return last known value for one or more Objects.\n\nIf maxDepth=0, recursively includes all values from HasComponent children (infinite depth).\nOtherwise, recurses only to the specified depth (1=no recursion, just this element).\n\nRequest body: {\"elementIds\": [\"...\", \"...\"]}\n\nReturns bulk response with succeeded/failed.","operationId":"queryLastKnownValues","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetObjectValueRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkResponse_CurrentValueResult_"}}}},"206":{"description":"Partial Content — server-imposed depth limit reached; response contains available data only","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkResponse_CurrentValueResult_"}}}},"default":{"description":"Error — see error.code for the HTTP status code (400, 401, 403, 404, 500, etc.)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/objects/history":{"post":{"tags":["Query"],"summary":"Query Historical Values","description":"Get the historical values for one or more Objects.\n\nIf maxDepth=0, recursively includes all values from HasComponent children (infinite depth).\nOtherwise, recurses only to the specified depth (1=no recursion, just this element).\n\nRequest body: {\"elementIds\": [\"...\", \"...\"]}\n\nReturns bulk response with succeeded/failed.","operationId":"queryHistoricalValues","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetObjectHistoryRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkResponse_HistoricalValueResult_"}}}},"206":{"description":"Partial Content — server-imposed depth limit reached; response contains available data only","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkResponse_HistoricalValueResult_"}}}},"default":{"description":"Error — see error.code for the HTTP status code (400, 401, 403, 404, 500, etc.)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/objects/{elementId}/history":{"get":{"tags":["Query"],"summary":"Get Historical Values","description":"Return historical values for a single Object. Optionally filter by time range.","operationId":"getHistoricalValues","parameters":[{"name":"elementId","in":"path","required":true,"schema":{"type":"string","title":"Elementid"}},{"name":"startTime","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 start time","title":"Starttime"},"description":"ISO 8601 start time"},{"name":"endTime","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 end time","title":"Endtime"},"description":"ISO 8601 end time"},{"name":"maxDepth","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Recursion depth through HasComponent. 0=infinite, 1=no recursion","default":1,"title":"Maxdepth"},"description":"Recursion depth through HasComponent. 0=infinite, 1=no recursion"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse_HistoricalValueResult_"}}}},"206":{"description":"Partial Content — server-imposed depth limit reached; response contains available data only","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse_HistoricalValueResult_"}}}},"404":{"description":"Not Found — ElementId or resource does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"default":{"description":"Error — see error.code for the HTTP status code (400, 401, 403, 404, 500, etc.)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"put":{"tags":["Update"],"summary":"Update Historical Values of Object","description":"Update the historical values for one or more Objects","operationId":"updateObjectHistory","parameters":[{"name":"elementId","in":"path","required":true,"schema":{"type":"string","title":"Elementid"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"501":{"description":"Not Implemented — optional feature not supported by this server","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found — ElementId or resource does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"default":{"description":"Error — see error.code for the HTTP status code (400, 401, 403, 404, 500, etc.)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/objects/{elementId}/value":{"put":{"tags":["Update"],"summary":"Update Value of Object","description":"Update the value of an Object","operationId":"updateObjectValue","parameters":[{"name":"elementId","in":"path","required":true,"schema":{"type":"string","title":"Elementid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Body"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse_NoneType_"}}}},"404":{"description":"Not Found — ElementId or resource does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"default":{"description":"Error — see error.code for the HTTP status code (400, 401, 403, 404, 500, etc.)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/subscriptions":{"post":{"tags":["Subscribe"],"summary":"Create Subscription","description":"Create a new subscription. Returns a unique subscriptionId the client must cache.\nThere is no way to list all subscriptions; the client must track the returned ID.","operationId":"createSubscription","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSubscriptionRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse_CreateSubscriptionResponse_"}}}},"default":{"description":"Error — see error.code for the HTTP status code (400, 401, 403, 404, 500, etc.)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/subscriptions/register":{"post":{"tags":["Subscribe"],"summary":"Register Monitored Items","description":"Add objects to the subscription. subscriptionId is passed in the request body.","operationId":"registerMonitoredItems","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegisterMonitoredItemsRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkResponse_NoneType_"}}}},"404":{"description":"Not Found — ElementId or resource does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"default":{"description":"Error — see error.code for the HTTP status code (400, 401, 403, 404, 500, etc.)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/subscriptions/unregister":{"post":{"tags":["Subscribe"],"summary":"Remove Monitored Items","description":"Remove objects from the subscription. subscriptionId is passed in the request body.","operationId":"removeMonitoredItems","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegisterMonitoredItemsRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkResponse_NoneType_"}}}},"404":{"description":"Not Found — ElementId or resource does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"default":{"description":"Error — see error.code for the HTTP status code (400, 401, 403, 404, 500, etc.)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/subscriptions/stream":{"post":{"tags":["Subscribe"],"summary":"Stream Values (SSE)","description":"Open a Server-Sent Events (SSE) stream. subscriptionId is passed in the request body.","operationId":"streamSubscription","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StreamRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not Found — ElementId or resource does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"default":{"description":"Error — see error.code for the HTTP status code (400, 401, 403, 404, 500, etc.)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/subscriptions/sync":{"post":{"tags":["Subscribe"],"summary":"Sync Values","description":"Acknowledge previously received updates and return all pending updates in one call.\n\nIf `lastSequenceNumber` is provided, all queued updates with sequenceNumber <= lastSequenceNumber are removed first,\nthen the remaining (newer) updates are returned. subscriptionId is passed in the request body.","operationId":"syncSubscription","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse_List_SyncUpdate__"}}}},"404":{"description":"Not Found — ElementId or resource does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"default":{"description":"Error — see error.code for the HTTP status code (400, 401, 403, 404, 500, etc.)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/subscriptions/delete":{"post":{"tags":["Subscribe"],"summary":"Delete Subscriptions","description":"Delete one or more subscriptions by ID. subscriptionIds are passed in the request body.","operationId":"deleteSubscriptions","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteSubscriptionsRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkResponse_NoneType_"}}}},"default":{"description":"Error — see error.code for the HTTP status code (400, 401, 403, 404, 500, etc.)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/subscriptions/list":{"post":{"tags":["Subscribe"],"summary":"List Subscriptions","description":"Get one or more subscriptions by ID to check their existence and current configuration.","operationId":"listSubscriptions","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListSubscriptionsRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkResponse_SubscriptionDetail_"}}}},"default":{"description":"Error — see error.code for the HTTP status code (400, 401, 403, 404, 500, etc.)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}},"components":{"schemas":{"BulkResponse_CurrentValueResult_":{"properties":{"success":{"type":"boolean","title":"Success"},"results":{"items":{"$ref":"#/components/schemas/BulkResultItem_CurrentValueResult_"},"type":"array","title":"Results"}},"type":"object","required":["success","results"],"title":"BulkResponse[CurrentValueResult]"},"BulkResponse_HistoricalValueResult_":{"properties":{"success":{"type":"boolean","title":"Success"},"results":{"items":{"$ref":"#/components/schemas/BulkResultItem_HistoricalValueResult_"},"type":"array","title":"Results"}},"type":"object","required":["success","results"],"title":"BulkResponse[HistoricalValueResult]"},"BulkResponse_List_RelatedObjectResult__":{"properties":{"success":{"type":"boolean","title":"Success"},"results":{"items":{"$ref":"#/components/schemas/BulkResultItem_List_RelatedObjectResult__"},"type":"array","title":"Results"}},"type":"object","required":["success","results"],"title":"BulkResponse[List[RelatedObjectResult]]"},"BulkResponse_NoneType_":{"properties":{"success":{"type":"boolean","title":"Success"},"results":{"items":{"$ref":"#/components/schemas/BulkResultItem_NoneType_"},"type":"array","title":"Results"}},"type":"object","required":["success","results"],"title":"BulkResponse[NoneType]"},"BulkResponse_ObjectInstanceResponse_":{"properties":{"success":{"type":"boolean","title":"Success"},"results":{"items":{"$ref":"#/components/schemas/BulkResultItem_ObjectInstanceResponse_"},"type":"array","title":"Results"}},"type":"object","required":["success","results"],"title":"BulkResponse[ObjectInstanceResponse]"},"BulkResponse_ObjectTypeResponse_":{"properties":{"success":{"type":"boolean","title":"Success"},"results":{"items":{"$ref":"#/components/schemas/BulkResultItem_ObjectTypeResponse_"},"type":"array","title":"Results"}},"type":"object","required":["success","results"],"title":"BulkResponse[ObjectTypeResponse]"},"BulkResponse_RelationshipType_":{"properties":{"success":{"type":"boolean","title":"Success"},"results":{"items":{"$ref":"#/components/schemas/BulkResultItem_RelationshipType_"},"type":"array","title":"Results"}},"type":"object","required":["success","results"],"title":"BulkResponse[RelationshipType]"},"BulkResponse_SubscriptionDetail_":{"properties":{"success":{"type":"boolean","title":"Success"},"results":{"items":{"$ref":"#/components/schemas/BulkResultItem_SubscriptionDetail_"},"type":"array","title":"Results"}},"type":"object","required":["success","results"],"title":"BulkResponse[SubscriptionDetail]"},"BulkResultItem_CurrentValueResult_":{"properties":{"success":{"type":"boolean","title":"Success"},"elementId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Elementid"},"subscriptionId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subscriptionid"},"result":{"anyOf":[{"$ref":"#/components/schemas/CurrentValueResult"},{"type":"null"}]},"error":{"anyOf":[{"$ref":"#/components/schemas/ErrorDetail"},{"type":"null"}]}},"type":"object","required":["success"],"title":"BulkResultItem[CurrentValueResult]"},"BulkResultItem_HistoricalValueResult_":{"properties":{"success":{"type":"boolean","title":"Success"},"elementId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Elementid"},"subscriptionId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subscriptionid"},"result":{"anyOf":[{"$ref":"#/components/schemas/HistoricalValueResult"},{"type":"null"}]},"error":{"anyOf":[{"$ref":"#/components/schemas/ErrorDetail"},{"type":"null"}]}},"type":"object","required":["success"],"title":"BulkResultItem[HistoricalValueResult]"},"BulkResultItem_List_RelatedObjectResult__":{"properties":{"success":{"type":"boolean","title":"Success"},"elementId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Elementid"},"subscriptionId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subscriptionid"},"result":{"anyOf":[{"items":{"$ref":"#/components/schemas/RelatedObjectResult"},"type":"array"},{"type":"null"}],"title":"Result"},"error":{"anyOf":[{"$ref":"#/components/schemas/ErrorDetail"},{"type":"null"}]}},"type":"object","required":["success"],"title":"BulkResultItem[List[RelatedObjectResult]]"},"BulkResultItem_NoneType_":{"properties":{"success":{"type":"boolean","title":"Success"},"elementId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Elementid"},"subscriptionId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subscriptionid"},"result":{"type":"null","title":"Result"},"error":{"anyOf":[{"$ref":"#/components/schemas/ErrorDetail"},{"type":"null"}]}},"type":"object","required":["success"],"title":"BulkResultItem[NoneType]"},"BulkResultItem_ObjectInstanceResponse_":{"properties":{"success":{"type":"boolean","title":"Success"},"elementId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Elementid"},"subscriptionId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subscriptionid"},"result":{"anyOf":[{"$ref":"#/components/schemas/ObjectInstanceResponse"},{"type":"null"}]},"error":{"anyOf":[{"$ref":"#/components/schemas/ErrorDetail"},{"type":"null"}]}},"type":"object","required":["success"],"title":"BulkResultItem[ObjectInstanceResponse]"},"BulkResultItem_ObjectTypeResponse_":{"properties":{"success":{"type":"boolean","title":"Success"},"elementId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Elementid"},"subscriptionId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subscriptionid"},"result":{"anyOf":[{"$ref":"#/components/schemas/ObjectTypeResponse"},{"type":"null"}]},"error":{"anyOf":[{"$ref":"#/components/schemas/ErrorDetail"},{"type":"null"}]}},"type":"object","required":["success"],"title":"BulkResultItem[ObjectTypeResponse]"},"BulkResultItem_RelationshipType_":{"properties":{"success":{"type":"boolean","title":"Success"},"elementId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Elementid"},"subscriptionId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subscriptionid"},"result":{"anyOf":[{"$ref":"#/components/schemas/RelationshipType"},{"type":"null"}]},"error":{"anyOf":[{"$ref":"#/components/schemas/ErrorDetail"},{"type":"null"}]}},"type":"object","required":["success"],"title":"BulkResultItem[RelationshipType]"},"BulkResultItem_SubscriptionDetail_":{"properties":{"success":{"type":"boolean","title":"Success"},"elementId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Elementid"},"subscriptionId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subscriptionid"},"result":{"anyOf":[{"$ref":"#/components/schemas/SubscriptionDetail"},{"type":"null"}]},"error":{"anyOf":[{"$ref":"#/components/schemas/ErrorDetail"},{"type":"null"}]}},"type":"object","required":["success"],"title":"BulkResultItem[SubscriptionDetail]"},"CreateSubscriptionRequest":{"properties":{"clientId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Clientid","description":"Unique identifier for the client scoping this subscription"},"displayName":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Displayname","description":"Optional friendly name for the subscription"}},"type":"object","title":"CreateSubscriptionRequest"},"CreateSubscriptionResponse":{"properties":{"clientId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Clientid"},"subscriptionId":{"type":"string","title":"Subscriptionid"},"displayName":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Displayname"}},"type":"object","required":["subscriptionId"],"title":"CreateSubscriptionResponse"},"CurrentValueResult":{"properties":{"isComposition":{"type":"boolean","title":"Iscomposition","description":"True if this Object encapsulates composed child elements"},"value":{"title":"Value"},"quality":{"type":"string","title":"Quality","description":"Data quality indicator: Good, GoodNoData, Bad, or Uncertain"},"timestamp":{"type":"string","title":"Timestamp","description":"RFC 3339 UTC timestamp when this value was recorded"},"components":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/VQT"},"type":"object"},{"type":"null"}],"title":"Components","description":"Child element values, present only on composition elements when maxDepth > 1"}},"type":"object","required":["isComposition","value","quality","timestamp"],"title":"CurrentValueResult"},"DeleteSubscriptionsRequest":{"properties":{"clientId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Clientid","description":"The clientId scoping these subscriptions"},"subscriptionIds":{"items":{"type":"string"},"type":"array","title":"Subscriptionids","description":"List of subscription IDs to delete"}},"type":"object","required":["subscriptionIds"],"title":"DeleteSubscriptionsRequest"},"ErrorDetail":{"properties":{"code":{"type":"integer","title":"Code"},"message":{"type":"string","title":"Message"}},"type":"object","required":["code","message"],"title":"ErrorDetail"},"ErrorResponse":{"properties":{"success":{"type":"boolean","title":"Success","default":false},"error":{"$ref":"#/components/schemas/ErrorDetail"}},"type":"object","required":["error"],"title":"ErrorResponse"},"GetObjectHistoryRequest":{"properties":{"elementIds":{"items":{"type":"string"},"type":"array","title":"Elementids","description":"Array of element IDs to query"},"startTime":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Starttime","description":"ISO 8601 start time for filtering"},"endTime":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Endtime","description":"ISO 8601 end time for filtering"},"maxDepth":{"type":"integer","minimum":0.0,"title":"Maxdepth","description":"Controls recursion depth. 0=infinite, 1=no recursion","default":1}},"type":"object","required":["elementIds"],"title":"GetObjectHistoryRequest","description":"Request model for POST /objects/history"},"GetObjectTypesRequest":{"properties":{"elementIds":{"items":{"type":"string"},"type":"array","title":"Elementids","description":"Array of element IDs to query"}},"type":"object","required":["elementIds"],"title":"GetObjectTypesRequest","description":"Request model for POST /objecttypes/query"},"GetObjectValueRequest":{"properties":{"elementIds":{"items":{"type":"string"},"type":"array","title":"Elementids","description":"Array of element IDs to query"},"maxDepth":{"type":"integer","minimum":0.0,"title":"Maxdepth","description":"Controls recursion depth. 0=infinite, 1=no recursion","default":1}},"type":"object","required":["elementIds"],"title":"GetObjectValueRequest","description":"Request model for POST /objects/value"},"GetObjectsRequest":{"properties":{"elementIds":{"items":{"type":"string"},"type":"array","title":"Elementids","description":"Array of element IDs to query"},"includeMetadata":{"type":"boolean","title":"Includemetadata","description":"Include full metadata in response","default":false}},"type":"object","required":["elementIds"],"title":"GetObjectsRequest","description":"Request model for POST /objects/query"},"GetRelatedObjectsRequest":{"properties":{"elementIds":{"items":{"type":"string"},"type":"array","title":"Elementids","description":"Array of element IDs to query"},"relationshipType":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Relationshiptype","description":"Filter by relationship type"},"includeMetadata":{"type":"boolean","title":"Includemetadata","description":"Include full metadata in response","default":false}},"type":"object","required":["elementIds"],"title":"GetRelatedObjectsRequest","description":"Request model for POST /objects/related"},"GetRelationshipTypesRequest":{"properties":{"elementIds":{"items":{"type":"string"},"type":"array","title":"Elementids","description":"Array of element IDs to query"}},"type":"object","required":["elementIds"],"title":"GetRelationshipTypesRequest","description":"Request model for POST /relationshiptypes/query"},"HistoricalValueResult":{"properties":{"isComposition":{"type":"boolean","title":"Iscomposition","description":"True if this Object encapsulates composed child elements"},"values":{"items":{"$ref":"#/components/schemas/VQT"},"type":"array","title":"Values","description":"Ordered array of VQT objects for the requested time range"}},"type":"object","required":["isComposition","values"],"title":"HistoricalValueResult"},"ListSubscriptionsRequest":{"properties":{"clientId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Clientid","description":"The clientId scoping these subscriptions"},"subscriptionIds":{"items":{"type":"string"},"type":"array","title":"Subscriptionids","description":"List of subscription IDs to retrieve"}},"type":"object","required":["subscriptionIds"],"title":"ListSubscriptionsRequest"},"Namespace":{"properties":{"uri":{"type":"string","title":"Uri","description":"Namespace URI"},"displayName":{"type":"string","title":"Displayname","description":"Namespace name"}},"type":"object","required":["uri","displayName"],"title":"Namespace"},"ObjectInstanceMetadata":{"properties":{"typeNamespaceUri":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Typenamespaceuri"},"sourceTypeId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sourcetypeid"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"relationships":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Relationships"},"extendedAttributes":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Extendedattributes"},"system":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"System"}},"type":"object","title":"ObjectInstanceMetadata"},"ObjectInstanceResponse":{"properties":{"elementId":{"type":"string","title":"Elementid"},"displayName":{"type":"string","title":"Displayname"},"typeElementId":{"type":"string","title":"Typeelementid"},"parentId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parentid"},"isComposition":{"type":"boolean","title":"Iscomposition"},"isExtended":{"type":"boolean","title":"Isextended","default":false},"metadata":{"anyOf":[{"$ref":"#/components/schemas/ObjectInstanceMetadata"},{"type":"null"}]}},"type":"object","required":["elementId","displayName","typeElementId","isComposition"],"title":"ObjectInstanceResponse"},"ObjectTypeResponse":{"properties":{"elementId":{"type":"string","title":"Elementid"},"displayName":{"type":"string","title":"Displayname"},"namespaceUri":{"type":"string","title":"Namespaceuri"},"sourceTypeId":{"type":"string","title":"Sourcetypeid","description":"Class or member of the Namespace that defines this type"},"version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Version"},"schema":{"additionalProperties":true,"type":"object","title":"Schema","description":"JSON Schema definition for this object type"},"related":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Related"}},"type":"object","required":["elementId","displayName","namespaceUri","sourceTypeId","schema"],"title":"ObjectTypeResponse"},"RegisterMonitoredItemsRequest":{"properties":{"clientId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Clientid","description":"The clientId scoping this subscription"},"subscriptionId":{"type":"string","title":"Subscriptionid","description":"The subscription to register items with"},"elementIds":{"items":{"type":"string"},"type":"array","title":"Elementids"},"maxDepth":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Maxdepth","default":1}},"type":"object","required":["subscriptionId","elementIds"],"title":"RegisterMonitoredItemsRequest"},"RelatedObjectResult":{"properties":{"sourceRelationship":{"type":"string","title":"Sourcerelationship"},"object":{"$ref":"#/components/schemas/ObjectInstanceResponse"}},"type":"object","required":["sourceRelationship","object"],"title":"RelatedObjectResult"},"RelationshipType":{"properties":{"elementId":{"type":"string","title":"Elementid","description":"Unique string identifier for the relationship type"},"displayName":{"type":"string","title":"Displayname","description":"Relationship type name"},"namespaceUri":{"type":"string","title":"Namespaceuri","description":"Namespace URI"},"relationshipId":{"type":"string","title":"Relationshipid","description":"Class or member of the Namespace that defines this relationship type"},"reverseOf":{"type":"string","title":"Reverseof","description":"ElementId of the reverse relationship type"}},"type":"object","required":["elementId","displayName","namespaceUri","relationshipId","reverseOf"],"title":"RelationshipType"},"ServerCapabilities":{"properties":{"query":{"$ref":"#/components/schemas/_QueryCapabilities"},"update":{"$ref":"#/components/schemas/_UpdateCapabilities"},"subscribe":{"$ref":"#/components/schemas/_SubscribeCapabilities"}},"type":"object","required":["query","update","subscribe"],"title":"ServerCapabilities"},"ServerInfo":{"properties":{"specVersion":{"type":"string","title":"Specversion"},"serverVersion":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Serverversion"},"serverName":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Servername"},"capabilities":{"$ref":"#/components/schemas/ServerCapabilities"}},"type":"object","required":["specVersion","capabilities"],"title":"ServerInfo"},"StreamRequest":{"properties":{"clientId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Clientid","description":"The clientId scoping this subscription"},"subscriptionId":{"type":"string","title":"Subscriptionid","description":"The subscription to open a stream for"}},"type":"object","required":["subscriptionId"],"title":"StreamRequest"},"SubscriptionDetail":{"properties":{"subscriptionId":{"type":"string","title":"Subscriptionid"},"displayName":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Displayname"},"monitoredObjects":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Monitoredobjects"}},"type":"object","required":["subscriptionId","monitoredObjects"],"title":"SubscriptionDetail"},"SuccessResponse_CreateSubscriptionResponse_":{"properties":{"success":{"type":"boolean","title":"Success"},"result":{"anyOf":[{"$ref":"#/components/schemas/CreateSubscriptionResponse"},{"type":"null"}]}},"type":"object","required":["success"],"title":"SuccessResponse[CreateSubscriptionResponse]"},"SuccessResponse_HistoricalValueResult_":{"properties":{"success":{"type":"boolean","title":"Success"},"result":{"anyOf":[{"$ref":"#/components/schemas/HistoricalValueResult"},{"type":"null"}]}},"type":"object","required":["success"],"title":"SuccessResponse[HistoricalValueResult]"},"SuccessResponse_List_Namespace__":{"properties":{"success":{"type":"boolean","title":"Success"},"result":{"anyOf":[{"items":{"$ref":"#/components/schemas/Namespace"},"type":"array"},{"type":"null"}],"title":"Result"}},"type":"object","required":["success"],"title":"SuccessResponse[List[Namespace]]"},"SuccessResponse_List_ObjectInstanceResponse__":{"properties":{"success":{"type":"boolean","title":"Success"},"result":{"anyOf":[{"items":{"$ref":"#/components/schemas/ObjectInstanceResponse"},"type":"array"},{"type":"null"}],"title":"Result"}},"type":"object","required":["success"],"title":"SuccessResponse[List[ObjectInstanceResponse]]"},"SuccessResponse_List_ObjectTypeResponse__":{"properties":{"success":{"type":"boolean","title":"Success"},"result":{"anyOf":[{"items":{"$ref":"#/components/schemas/ObjectTypeResponse"},"type":"array"},{"type":"null"}],"title":"Result"}},"type":"object","required":["success"],"title":"SuccessResponse[List[ObjectTypeResponse]]"},"SuccessResponse_List_RelationshipType__":{"properties":{"success":{"type":"boolean","title":"Success"},"result":{"anyOf":[{"items":{"$ref":"#/components/schemas/RelationshipType"},"type":"array"},{"type":"null"}],"title":"Result"}},"type":"object","required":["success"],"title":"SuccessResponse[List[RelationshipType]]"},"SuccessResponse_List_SyncUpdate__":{"properties":{"success":{"type":"boolean","title":"Success"},"result":{"anyOf":[{"items":{"$ref":"#/components/schemas/SyncUpdate"},"type":"array"},{"type":"null"}],"title":"Result"}},"type":"object","required":["success"],"title":"SuccessResponse[List[SyncUpdate]]"},"SuccessResponse_NoneType_":{"properties":{"success":{"type":"boolean","title":"Success"},"result":{"type":"null","title":"Result"}},"type":"object","required":["success"],"title":"SuccessResponse[NoneType]"},"SuccessResponse_ServerInfo_":{"properties":{"success":{"type":"boolean","title":"Success"},"result":{"anyOf":[{"$ref":"#/components/schemas/ServerInfo"},{"type":"null"}]}},"type":"object","required":["success"],"title":"SuccessResponse[ServerInfo]"},"SyncRequest":{"properties":{"clientId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Clientid","description":"The clientId scoping this subscription"},"subscriptionId":{"type":"string","title":"Subscriptionid","description":"The subscription to sync"},"lastSequenceNumber":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Lastsequencenumber","description":"Acknowledge all updates through this sequence number before returning new ones"}},"type":"object","required":["subscriptionId"],"title":"SyncRequest"},"SyncUpdate":{"properties":{"sequenceNumber":{"type":"integer","title":"Sequencenumber"},"elementId":{"type":"string","title":"Elementid"},"value":{"title":"Value"},"quality":{"type":"string","title":"Quality","description":"Data quality indicator: Good, GoodNoData, Bad, or Uncertain"},"timestamp":{"type":"string","title":"Timestamp","description":"RFC 3339 UTC timestamp when this value was recorded"}},"additionalProperties":true,"type":"object","required":["sequenceNumber","elementId","value","quality","timestamp"],"title":"SyncUpdate"},"VQT":{"properties":{"value":{"title":"Value"},"quality":{"type":"string","title":"Quality","description":"Data quality indicator: Good, GoodNoData, Bad, or Uncertain"},"timestamp":{"type":"string","title":"Timestamp","description":"RFC 3339 UTC timestamp when this value was recorded"}},"type":"object","required":["value","quality","timestamp"],"title":"VQT"},"_QueryCapabilities":{"properties":{"history":{"type":"boolean","title":"History"}},"type":"object","required":["history"],"title":"_QueryCapabilities"},"_SubscribeCapabilities":{"properties":{"stream":{"type":"boolean","title":"Stream"}},"type":"object","required":["stream"],"title":"_SubscribeCapabilities"},"_UpdateCapabilities":{"properties":{"current":{"type":"boolean","title":"Current"},"history":{"type":"boolean","title":"History"}},"type":"object","required":["current","history"],"title":"_UpdateCapabilities"}}}}