{"openapi":"3.0.1","info":{"title":"TrendMiner Assets API","description":"API for modeling asset frameworks.","termsOfService":"urn:tos'","contact":{"name":"TrendMiner","url":"http://www.trendminer.com","email":"support@trendminer.com"},"license":{"name":"Commercial","url":"http://www.trendminer.com"},"version":"1.0.0"},"servers":[{"url":"https://tm-toggles-next.trendminer.net/af","description":"Generated server url"}],"security":[{"bearerAuth":[]},{"openIdConnect":[]}],"tags":[{"name":"PublicDownloadGenerator","description":"Public download generator"}],"paths":{"/source/{identifier}":{"get":{"tags":["Source"],"summary":"Get specific source by its identifier.","operationId":"getSource","parameters":[{"name":"identifier","in":"path","description":"The identifier of the source.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Source"}},"application/hal+json":{"schema":{"$ref":"#/components/schemas/Source"}}}}}},"put":{"tags":["Source"],"summary":"Update existing source.","operationId":"updateSource","parameters":[{"name":"identifier","in":"path","description":"The identifier of the source.","required":true,"schema":{"type":"string"}},{"name":"name","in":"query","description":"The name of the source.","required":true,"schema":{"type":"String"}},{"name":"published","in":"query","description":"Indicator whether the source is published or not.","required":true,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Source"}},"application/hal+json":{"schema":{"$ref":"#/components/schemas/Source"}}}}}},"delete":{"tags":["Source"],"summary":"Delete existing source.","operationId":"deleteSource","parameters":[{"name":"identifier","in":"path","description":"The identifier of the source.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"}}}},"/builder/{sourceIdentifier}/node/{identifier}":{"put":{"tags":["Asset Tree Builder"],"summary":"Update node.","operationId":"updateNode","parameters":[{"name":"sourceIdentifier","in":"path","description":"The source identifier.","required":true,"schema":{"type":"string"}},{"name":"identifier","in":"path","description":"The node identifier.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NodeBuilderModel"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NodeBuilderRepresentationModel"}},"application/hal+json":{"schema":{"$ref":"#/components/schemas/NodeBuilderRepresentationModel"}}}}}},"delete":{"tags":["Asset Tree Builder"],"summary":"Delete node.","operationId":"deleteNode","parameters":[{"name":"sourceIdentifier","in":"path","description":"The source identifier.","required":true,"schema":{"type":"string"}},{"name":"identifier","in":"path","description":"The node identifier.","required":true,"schema":{"type":"string"}},{"name":"recursive","in":"query","description":"Delete children as well.","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK"}}}},"/assets/{structureId}/accessrule/{accessRuleId}":{"get":{"tags":["Assets Access Rules (v1) - Deprecated"],"summary":"Get the specified access rule for the specified structure.","operationId":"getAccessRule","parameters":[{"name":"structureId","in":"path","description":"The identifier of the asset's structure.","required":true,"schema":{"type":"string"}},{"name":"accessRuleId","in":"path","description":"The identifier of the access rule.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessRule"}},"application/hal+json":{"schema":{"$ref":"#/components/schemas/AccessRule"}}}},"404":{"description":"The resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessRule"}},"application/hal+json":{"schema":{"$ref":"#/components/schemas/AccessRule"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessRule"}},"application/hal+json":{"schema":{"$ref":"#/components/schemas/AccessRule"}}}}},"deprecated":true},"put":{"tags":["Assets Access Rules (v1) - Deprecated"],"summary":"Update the specified access rule for the specified structure.","operationId":"updateAccessRule","parameters":[{"name":"structureId","in":"path","description":"The identifier of the asset's structure.","required":true,"schema":{"type":"string"}},{"name":"accessRuleId","in":"path","description":"The identifier of the access rule.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The access rule model.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetAccessRuleModel"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessRule"}},"application/hal+json":{"schema":{"$ref":"#/components/schemas/AccessRule"}}}},"404":{"description":"The resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessRule"}},"application/hal+json":{"schema":{"$ref":"#/components/schemas/AccessRule"}}}},"400":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessRule"}},"application/hal+json":{"schema":{"$ref":"#/components/schemas/AccessRule"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessRule"}},"application/hal+json":{"schema":{"$ref":"#/components/schemas/AccessRule"}}}}},"deprecated":true},"delete":{"tags":["Assets Access Rules (v1) - Deprecated"],"summary":"Delete the specified access rule for the specified structure.","operationId":"deleteAccessRule","parameters":[{"name":"structureId","in":"path","description":"The identifier of the asset's structure.","required":true,"schema":{"type":"string"}},{"name":"accessRuleId","in":"path","description":"The identifier of the access rule.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Deleted"},"404":{"description":"The resource was not found"},"401":{"description":"Unauthorized"}},"deprecated":true}},"/asset/{path}/accessrule/{accessRuleId}":{"get":{"tags":["Asset Access Rules"],"summary":"Get the specified access rule for the specified asset.","operationId":"getAccessRule_1","parameters":[{"name":"path","in":"path","description":"The identifier of the asset.","required":true,"schema":{"type":"string"}},{"name":"accessRuleId","in":"path","description":"The identifier of the access rule.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessRule"}},"application/hal+json":{"schema":{"$ref":"#/components/schemas/AccessRule"}}}},"404":{"description":"The resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessRule"}},"application/hal+json":{"schema":{"$ref":"#/components/schemas/AccessRule"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessRule"}},"application/hal+json":{"schema":{"$ref":"#/components/schemas/AccessRule"}}}}}},"put":{"tags":["Asset Access Rules"],"summary":"Update the specified access rule for the specified asset.","operationId":"updateAccessRule_1","parameters":[{"name":"path","in":"path","description":"The identifier of the asset.","required":true,"schema":{"type":"string"}},{"name":"accessRuleId","in":"path","description":"The identifier of the access rule.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The access rule model.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetAccessRuleModel"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessRule"}},"application/hal+json":{"schema":{"$ref":"#/components/schemas/AccessRule"}}}},"404":{"description":"The resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessRule"}},"application/hal+json":{"schema":{"$ref":"#/components/schemas/AccessRule"}}}},"400":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessRule"}},"application/hal+json":{"schema":{"$ref":"#/components/schemas/AccessRule"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessRule"}},"application/hal+json":{"schema":{"$ref":"#/components/schemas/AccessRule"}}}}}},"delete":{"tags":["Asset Access Rules"],"summary":"Delete the specified access rule for the specified asset.","operationId":"deleteAccessRule_1","parameters":[{"name":"path","in":"path","description":"The identifier of the asset.","required":true,"schema":{"type":"string"}},{"name":"accessRuleId","in":"path","description":"The identifier of the access rule.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Deleted"},"404":{"description":"The resource was not found"},"401":{"description":"Unauthorized"}}}},"/sync":{"get":{"tags":["Sync"],"summary":"Get sync history for a specific datasource.","operationId":"getSyncHistory","parameters":[{"name":"datasourceId","in":"query","description":"The datasource identifier.","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Zero-based page index (0..N)","schema":{"type":"integer","default":0}},{"name":"size","in":"query","description":"The size of the page to be returned","schema":{"type":"integer","default":20}},{"name":"sort","in":"query","description":"Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedModelSyncJob"}},"application/hal+json":{"schema":{"$ref":"#/components/schemas/PagedModelSyncJob"}}}}}},"post":{"tags":["Sync"],"summary":"Sync a specific datasource.","operationId":"scheduleSync","parameters":[{"name":"datasourceId","in":"query","description":"The datasource identifier.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}},"application/hal+json":{"schema":{"type":"string"}}}}}}},"/sync/status":{"post":{"tags":["Sync"],"summary":"Get status for the latest sync job per datasource in bulk.","operationId":"getSyncStatusInBulk","requestBody":{"description":"List of datasource identifiers.","content":{"application/json":{"schema":{"type":"array","items":{"type":"string","format":"uuid"}}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SourceSyncJob"}}},"application/hal+json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SourceSyncJob"}}}}}}}},"/structure/permission":{"post":{"tags":["Asset Permissions"],"summary":"Get the granted permissions for the specified structures for the current user.","operationId":"getStructurePermissions","requestBody":{"description":"The list of structure identifiers.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdListModel"}}},"required":true},"responses":{"200":{"description":"The resource was found with the provided permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GrantedPermissionMap"}},"application/hal+json":{"schema":{"$ref":"#/components/schemas/GrantedPermissionMap"}}}},"404":{"description":"The resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GrantedPermissionMap"}},"application/hal+json":{"schema":{"$ref":"#/components/schemas/GrantedPermissionMap"}}}}}}},"/source":{"get":{"tags":["Source"],"summary":"List all sources.","operationId":"getAllSources","parameters":[{"name":"query","in":"query","description":"Optional RSQL search filter.","required":false,"schema":{"type":"String"}},{"name":"page","in":"query","description":"Zero-based page index (0..N)","schema":{"type":"integer","default":0}},{"name":"size","in":"query","description":"The size of the page to be returned","schema":{"type":"integer","default":20}},{"name":"sort","in":"query","description":"Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedModelSource"}},"application/hal+json":{"schema":{"$ref":"#/components/schemas/PagedModelSource"}}}}}},"post":{"tags":["Source"],"summary":"Create new source.","operationId":"createSource","parameters":[{"name":"name","in":"query","description":"The name of the source.","required":true,"schema":{"type":"String"}},{"name":"published","in":"query","description":"Indicator whether the source is published or not.","required":true,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Source"}},"application/hal+json":{"schema":{"$ref":"#/components/schemas/Source"}}}}}}},"/source/{identifier}/move":{"post":{"tags":["Source"],"summary":"Reorder source's root.","operationId":"moveSource","parameters":[{"name":"identifier","in":"path","description":"The identifier of the source.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Operation to be applied on the order.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SourceReorderingModel"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Source"}},"application/hal+json":{"schema":{"$ref":"#/components/schemas/Source"}}}}}}},"/source/history":{"post":{"tags":["Source"],"summary":"List all imports for an existing source.","operationId":"getSourceHistoryInBulk","requestBody":{"description":"List of source identifiers.","content":{"application/json":{"schema":{"type":"array","items":{"type":"string","format":"uuid"}}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SourceSyncJob"}}},"application/hal+json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SourceSyncJob"}}}}}}}},"/permissions":{"post":{"tags":["Asset Permissions"],"summary":"Get the granted permissions for the specified assets for the current user.","operationId":"getAssetPermissions","requestBody":{"description":"The list of asset identifiers.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdListModel"}}},"required":true},"responses":{"200":{"description":"The resource was found with the provided permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GrantedPermissions"}},"application/hal+json":{"schema":{"$ref":"#/components/schemas/GrantedPermissions"}}}},"404":{"description":"The resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GrantedPermissions"}},"application/hal+json":{"schema":{"$ref":"#/components/schemas/GrantedPermissions"}}}}}}},"/node/permission":{"post":{"tags":["Asset Permissions"],"summary":"Get the granted permissions for the specified nodes for the current user.","operationId":"getNodePermissions","requestBody":{"description":"The list of node identifiers.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdListModel"}}},"required":true},"responses":{"200":{"description":"The resource was found with the provided permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GrantedPermissionMap"}},"application/hal+json":{"schema":{"$ref":"#/components/schemas/GrantedPermissionMap"}}}},"404":{"description":"The resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GrantedPermissionMap"}},"application/hal+json":{"schema":{"$ref":"#/components/schemas/GrantedPermissionMap"}}}}}}},"/download/generate":{"post":{"tags":["PublicDownloadGenerator"],"summary":"Generate","operationId":"generate","requestBody":{"description":"The model containing the requested link","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinkModel"}}},"required":true},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataModel"}}}}}}},"/builder":{"post":{"tags":["Asset Tree Builder"],"summary":"Create new source.","operationId":"createSource_1","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SourceBuilderModel"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Source"}},"application/hal+json":{"schema":{"$ref":"#/components/schemas/Source"}}}}}}},"/builder/{sourceIdentifier}/node":{"post":{"tags":["Asset Tree Builder"],"summary":"Create new node.","operationId":"createNode","parameters":[{"name":"sourceIdentifier","in":"path","description":"The source identifier.","required":true,"schema":{"type":"string"}},{"name":"force","in":"query","description":"Forces creation if node with same path and name exists","required":false,"schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NodeBuilderModel"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NodeBuilderRepresentationModel"}},"application/hal+json":{"schema":{"$ref":"#/components/schemas/NodeBuilderRepresentationModel"}}}}}}},"/assets/{structureId}/accessrule":{"get":{"tags":["Assets Access Rules (v1) - Deprecated"],"summary":"Get the access rule for the specified structure.","operationId":"getAllAccessRules","parameters":[{"name":"structureId","in":"path","description":"The identifier of the asset's structure.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AccessRule"}}},"application/hal+json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AccessRule"}}}}},"404":{"description":"The resource was not found","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AccessRule"}}},"application/hal+json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AccessRule"}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AccessRule"}}},"application/hal+json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AccessRule"}}}}}},"deprecated":true},"post":{"tags":["Assets Access Rules (v1) - Deprecated"],"summary":"Create an access rule for the specified structure.","operationId":"createAccessRule","parameters":[{"name":"structureId","in":"path","description":"The identifier of the asset's structure.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The access rule model.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetAccessRuleModel"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessRule"}},"application/hal+json":{"schema":{"$ref":"#/components/schemas/AccessRule"}}}},"404":{"description":"The resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessRule"}},"application/hal+json":{"schema":{"$ref":"#/components/schemas/AccessRule"}}}},"400":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessRule"}},"application/hal+json":{"schema":{"$ref":"#/components/schemas/AccessRule"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessRule"}},"application/hal+json":{"schema":{"$ref":"#/components/schemas/AccessRule"}}}}},"deprecated":true}},"/assets/structures":{"post":{"tags":["Assets"],"summary":"Retrieve the specified list structures.","operationId":"getStructuresByPath","parameters":[{"name":"useTimeSeriesIdentifier","in":"query","required":false,"schema":{"type":"boolean","default":false}}],"requestBody":{"description":"List of paths.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PathListModel"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Structure"}}},"application/hal+json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Structure"}}}}}},"deprecated":true}},"/assets/search":{"get":{"tags":["Assets"],"summary":"Search for all structures that match the query pattern.","operationId":"searchStructures","parameters":[{"name":"query","in":"query","description":"You can search on all the exposed properties of a node \n\nAvailable search operators:\nequal(==), not equal(!=), in(=in=), not in(=out=)\n\nAvailable logical operator;\nAND(;), OR(,)\n\nIf you want to use \\ literally, then double it as \\\\ \nWildcards &#8727 are supported\n\nExamples:\nsearch by name equal to node and description not equal to old: name=='node';description!='old'\n\nsearch by name like node or description equal to something name=='&#8727node&#8727',description=='something'","required":true,"schema":{"type":"string"}},{"name":"useTimeSeriesIdentifier","in":"query","required":false,"schema":{"type":"boolean","default":false}},{"name":"parent","in":"query","description":"the uuid of the parent structure.","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Zero-based page index (0..N)","schema":{"type":"integer","default":0}},{"name":"size","in":"query","description":"The size of the page to be returned","schema":{"type":"integer","default":20}},{"name":"sort","in":"query","description":"Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedModelStructure"}},"application/hal+json":{"schema":{"$ref":"#/components/schemas/PagedModelStructure"}}}}},"deprecated":true},"post":{"tags":["Assets"],"summary":"Search structures matching the specified query.","operationId":"searchStructuresWithPost","requestBody":{"description":"The search parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchParametersV1Model"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedModelStructure"}},"application/hal+json":{"schema":{"$ref":"#/components/schemas/PagedModelStructure"}}}}},"deprecated":true}},"/assets/nodes":{"post":{"tags":["Assets"],"summary":"Retrieve the specified list of nodes.","operationId":"getNodesByNodeId","parameters":[{"name":"useTimeSeriesIdentifier","in":"query","required":false,"schema":{"type":"boolean","default":false}}],"requestBody":{"description":"List of identifiers.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdListModel"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Node"}}},"application/hal+json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Node"}}}}}},"deprecated":true}},"/assets/convert/named-path":{"post":{"tags":["Assets"],"summary":"Converts a named path to the node identifier.","operationId":"convertNamedPathToNodeIdentifier","requestBody":{"description":"Named path list model","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NamedPathListModel"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Mappings"}},"application/hal+json":{"schema":{"$ref":"#/components/schemas/Mappings"}}}}}}},"/assets/convert/identifier":{"post":{"tags":["Assets"],"summary":"Converts a node identifier to the named path.","operationId":"convertNodeIdentifierToNamedPath","requestBody":{"description":"Id list model.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdListModel"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Mappings"}},"application/hal+json":{"schema":{"$ref":"#/components/schemas/Mappings"}}}}}}},"/asset":{"get":{"tags":["Asset"],"summary":"Get an asset by its path. Optionally include its ancestors.","operationId":"getAssetByPath","parameters":[{"name":"path","in":"query","description":"the ltree path to the asset.","required":false,"schema":{"type":"string"}},{"name":"includeAncestors","in":"query","description":"Flag whether to include ancestors or not.","required":false,"schema":{"type":"boolean"},"example":false},{"name":"useTimeSeriesIdentifier","in":"query","description":"Indicates if the Asset data reference should be resolved to a TimeSeriesIdentifier UUID or not.","required":false,"schema":{"type":"boolean"},"example":true},{"name":"resolveTimeSeriesData","in":"query","description":"Indicates if the timeseries data should be resolved for attributes of type DATAREFERENCE. Default is true","required":false,"schema":{"type":"boolean"},"example":true},{"name":"page","in":"query","description":"Zero-based page index (0..N)","schema":{"type":"integer","default":0}},{"name":"size","in":"query","description":"The size of the page to be returned","schema":{"type":"integer","default":20}},{"name":"sort","in":"query","description":"Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedModelAsset"}},"application/hal+json":{"schema":{"$ref":"#/components/schemas/PagedModelAsset"}}}}}},"post":{"tags":["Asset"],"summary":"Get assets by paths","operationId":"getAssetByPaths","parameters":[{"name":"useTimeSeriesIdentifier","in":"query","description":"Indicates if the Asset data reference should be resolved to a TimeSeriesIdentifier UUID or not.","required":false,"schema":{"type":"boolean"},"example":true},{"name":"resolveTimeSeriesData","in":"query","description":"Indicates if the timeseries data should be resolved for attributes of type DATAREFERENCE. Default is true","required":false,"schema":{"type":"boolean"},"example":true},{"name":"includeDeleted","in":"query","description":"Indicator whether to include the deleted assets or not. Default is false","required":false,"schema":{"type":"boolean"}}],"requestBody":{"description":"List of paths.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PathListModel"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Asset"}}}}}}}},"/asset/{path}/accessrule":{"get":{"tags":["Asset Access Rules"],"summary":"Get the access rule for the specified asset selected by path.","operationId":"getAllAccessRules_1","parameters":[{"name":"path","in":"path","description":"The path of the asset.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AccessRule"}}},"application/hal+json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AccessRule"}}}}},"404":{"description":"The resource was not found","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AccessRule"}}},"application/hal+json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AccessRule"}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AccessRule"}}},"application/hal+json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AccessRule"}}}}}}},"post":{"tags":["Asset Access Rules"],"summary":"Create an access rule for the specified asset.","operationId":"createAccessRule_1","parameters":[{"name":"path","in":"path","description":"The path of the asset.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The access rule model.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetAccessRuleModel"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessRule"}},"application/hal+json":{"schema":{"$ref":"#/components/schemas/AccessRule"}}}},"404":{"description":"The resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessRule"}},"application/hal+json":{"schema":{"$ref":"#/components/schemas/AccessRule"}}}},"400":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessRule"}},"application/hal+json":{"schema":{"$ref":"#/components/schemas/AccessRule"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessRule"}},"application/hal+json":{"schema":{"$ref":"#/components/schemas/AccessRule"}}}}}}},"/asset/search":{"get":{"tags":["Asset"],"summary":"Search assets matching the specified query.","operationId":"searchAsset","parameters":[{"name":"query","in":"query","description":"You can search on all the exposed properties of a node \n\nAvailable search operators:\nequal(==), not equal(!=), in(=in=), not in(=out=)\n\nAvailable logical operator;\nAND(;), OR(,)\n\nIf you want to use \\ literally, then double it as \\\\ \n\nWildcards &#8727 are supported\n\nExamples:\nsearch by name equal to node and description not equal to old: name=='node';description!='old'\n\nsearch by name like node or description equal to something name=='&#8727node&#8727',description=='something'search by name equal to 'node' and node is child of provided parent path 'A.B.C.D' : name=='node';paths=c='A.B.C.D'\n\nsearch by name like 'node' and node is descendant of provided ancestor path 'A.B' : name=='node';paths=d='A.B'","required":true,"schema":{"type":"string"}},{"name":"useTimeSeriesIdentifier","in":"query","description":"Indicates if the Asset data reference should be resolved to a TimeSeriesIdentifier UUID or not.","required":false,"schema":{"type":"boolean"},"example":true},{"name":"unnest","in":"query","description":"Unnest asset with multiple paths or not.","required":false,"schema":{"type":"boolean"},"example":true},{"name":"includeDeleted","in":"query","required":false,"schema":{"type":"boolean","default":false}},{"name":"resolveTimeSeriesData","in":"query","description":"Indicates if the timeseries data should be resolved for attributes of type DATAREFERENCE. Default is true","required":false,"schema":{"type":"boolean"},"example":true},{"name":"page","in":"query","description":"Zero-based page index (0..N)","schema":{"type":"integer","default":0}},{"name":"size","in":"query","description":"The size of the page to be returned","schema":{"type":"integer","default":20}},{"name":"sort","in":"query","description":"Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedModelAsset"}},"application/hal+json":{"schema":{"$ref":"#/components/schemas/PagedModelAsset"}}}}}},"post":{"tags":["Asset"],"summary":"Search assets matching the specified query.","operationId":"searchAssetUsingPost","requestBody":{"description":"Search assets matching the specified query.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NodeSearchParametersModel"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedModelAsset"}},"application/hal+json":{"schema":{"$ref":"#/components/schemas/PagedModelAsset"}}}}}}},"/asset/relatives":{"post":{"tags":["Asset"],"summary":"Get relatives for assets by their path","operationId":"getRelativesByPath","parameters":[{"name":"limit","in":"query","description":"Limit the response size, default is 10001.","required":false,"schema":{"type":"int"}},{"name":"useTimeSeriesIdentifier","in":"query","description":"Indicates if the Asset data reference should be resolved to a TimeSeriesIdentifier UUID or not.","required":false,"schema":{"type":"boolean"},"example":true},{"name":"resolveTimeSeriesData","in":"query","description":"Indicates if the timeseries data should be resolved for attributes of type DATAREFERENCE. Default is true","required":false,"schema":{"type":"boolean"},"example":true}],"requestBody":{"description":"List of relatives","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RelativesByPathModel"}}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"string","format":"uuid"}}},"application/hal+json":{"schema":{"type":"array","items":{"type":"string","format":"uuid"}}}}}}}},"/asset/convert/named-path":{"post":{"tags":["Asset Converter"],"summary":"Converts a named path to the node identifier.","operationId":"convertNamedPathToNodeIdentifier_1","requestBody":{"description":"Named path list model","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NamedPathListModel"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MappingsV2"}},"application/hal+json":{"schema":{"$ref":"#/components/schemas/MappingsV2"}}}}}}},"/asset/convert/identifier":{"post":{"tags":["Asset Converter"],"summary":"Converts a node identifier to the named path.","operationId":"convertNodeIdentifierToNamedPath_1","requestBody":{"description":"Id list model.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdListModel"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MappingsV2"}},"application/hal+json":{"schema":{"$ref":"#/components/schemas/MappingsV2"}}}}}}},"/sync/{identifier}":{"get":{"tags":["Sync"],"summary":"Get status for a specific sync job.","operationId":"getSyncStatus","parameters":[{"name":"identifier","in":"path","description":"The sync job's identifier.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncJob"}},"application/hal+json":{"schema":{"$ref":"#/components/schemas/SyncJob"}}}}}},"delete":{"tags":["Sync"],"summary":"Cancel execution of a specific sync job.","operationId":"cancelSync","parameters":[{"name":"identifier","in":"path","description":"The sync job's identifier.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncJob"}},"application/hal+json":{"schema":{"$ref":"#/components/schemas/SyncJob"}}}}}}},"/sync/search":{"get":{"tags":["Sync"],"summary":"Search for sync histories.","operationId":"searchSyncHistory","parameters":[{"name":"query","in":"query","description":"You can search on all the exposed properties of a sync job \n\nAvailable search operators:\nequal(==), not equal(!=), in(=in=), not in(=out=)\n\nAvailable logical operator;\nAND(;), OR(,)\n\nIf you want to use \\ literally, then double it as \\\\ \nWildcards &#8727 are supported\n","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Zero-based page index (0..N)","schema":{"type":"integer","default":0}},{"name":"size","in":"query","description":"The size of the page to be returned","schema":{"type":"integer","default":20}},{"name":"sort","in":"query","description":"Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedModelSyncJob"}},"application/hal+json":{"schema":{"$ref":"#/components/schemas/PagedModelSyncJob"}}}}}}},"/source/{identifier}/history":{"get":{"tags":["Source"],"summary":"List all imports for an existing source.","operationId":"getSourceHistory","parameters":[{"name":"identifier","in":"path","description":"The identifier of the source.","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Zero-based page index (0..N)","schema":{"type":"integer","default":0}},{"name":"size","in":"query","description":"The size of the page to be returned","schema":{"type":"integer","default":20}},{"name":"sort","in":"query","description":"Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedModelSyncJob"}},"application/hal+json":{"schema":{"$ref":"#/components/schemas/PagedModelSyncJob"}}}}}}},"/source/{identifier}/history/{syncJobIdentifier}":{"get":{"tags":["Source"],"summary":"Get the sync job details.","operationId":"getSyncJob","parameters":[{"name":"identifier","in":"path","description":"The identifier of the source.","required":true,"schema":{"type":"string"}},{"name":"syncJobIdentifier","in":"path","description":"The identifier of the sync job.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncJob"}},"application/hal+json":{"schema":{"$ref":"#/components/schemas/SyncJob"}}}}}}},"/source/{identifier}/history/{syncJobIdentifier}/original":{"get":{"tags":["Source"],"summary":"Download original CSV file.","operationId":"downloadImportFile","parameters":[{"name":"identifier","in":"path","description":"The identifier of the source.","required":true,"schema":{"type":"string"}},{"name":"syncJobIdentifier","in":"path","description":"The identifier of the sync job.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"}}}},"/source/{identifier}/history/{syncJobIdentifier}/error":{"get":{"tags":["Source"],"summary":"Download error CSV file.","operationId":"downloadImportErrorFile","parameters":[{"name":"identifier","in":"path","description":"The identifier of the source.","required":true,"schema":{"type":"string"}},{"name":"syncJobIdentifier","in":"path","description":"The identifier of the sync job.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"}}}},"/source/{identifier}/export":{"get":{"tags":["Source"],"summary":"Download current version for CSV source.","operationId":"exportSource","parameters":[{"name":"identifier","in":"path","description":"The identifier of the source.","required":true,"schema":{"type":"string"}},{"name":"includeDeleted","in":"query","description":"Indicator whether to include the deleted assets or not.","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK"}}}},"/assets/{structureId}/accessrule/inherited":{"get":{"tags":["Assets Access Rules (v1) - Deprecated"],"summary":"Get all inherited access rule for the specified structure.","operationId":"getInheritedAccessRules","parameters":[{"name":"structureId","in":"path","description":"The identifier of the asset's structure.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AccessRule"}}},"application/hal+json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AccessRule"}}}}},"404":{"description":"The resource was not found","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AccessRule"}}},"application/hal+json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AccessRule"}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AccessRule"}}},"application/hal+json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AccessRule"}}}}}},"deprecated":true}},"/assets/{id}":{"get":{"tags":["Assets"],"summary":"Gets the structure denoted by its UUID.","operationId":"getNodeByStructureId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"useTimeSeriesIdentifier","in":"query","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Structure"}},"application/hal+json":{"schema":{"$ref":"#/components/schemas/Structure"}}}}},"deprecated":true}},"/assets/structure/browse/{path}":{"get":{"tags":["Assets"],"summary":"Browse structures based on their path in the asset tree.","operationId":"browseStructure","parameters":[{"name":"path","in":"path","description":"the ltree path to the node.","required":true,"schema":{"type":"string"}},{"name":"useTimeSeriesIdentifier","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"includeAncestors","in":"query","description":"Flag wether to include ancestors or not.","required":false,"schema":{"type":"boolean"},"example":false},{"name":"page","in":"query","description":"Zero-based page index (0..N)","schema":{"type":"integer","default":0}},{"name":"size","in":"query","description":"The size of the page to be returned","schema":{"type":"integer","default":20}},{"name":"sort","in":"query","description":"Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedModelStructure"}},"application/hal+json":{"schema":{"$ref":"#/components/schemas/PagedModelStructure"}}}}},"deprecated":true}},"/assets/node/{id}":{"get":{"tags":["Assets"],"summary":"Gets the node denoted by its UUID.","operationId":"getNodeByNodeId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"useTimeSeriesIdentifier","in":"query","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Node"}},"application/hal+json":{"schema":{"$ref":"#/components/schemas/Node"}}}}},"deprecated":true}},"/assets/node/{id}/attributes":{"get":{"tags":["Assets"],"summary":"Search for all child attributes for a specified node that match the optional query pattern.","operationId":"searchAttributes","parameters":[{"name":"query","in":"query","description":"You can search on all the exposed properties of a node \n\nAvailable search operators:\nequal(==), not equal(!=), in(=in=), not in(=out=)\n\nAvailable logical operator;\nAND(;), OR(,)\n\nWildcards &#8727 are supported\n\nExamples:\nsearch by name equal to node and description not equal to old: name=='node';description!='old'\n\nsearch by name like node or description equal to something name=='&#8727node&#8727',description=='something'","required":false,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"useTimeSeriesIdentifier","in":"query","required":false,"schema":{"type":"boolean","default":false}},{"name":"parent","in":"query","description":"the uuid of the parent structure.","schema":{"type":"string"}},{"name":"page","in":"query","description":"Zero-based page index (0..N)","schema":{"type":"integer","default":0}},{"name":"size","in":"query","description":"The size of the page to be returned","schema":{"type":"integer","default":20}},{"name":"sort","in":"query","description":"Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedModelNode"}},"application/hal+json":{"schema":{"$ref":"#/components/schemas/PagedModelNode"}}}}},"deprecated":true}},"/assets/node/external/{externalId}":{"get":{"tags":["Assets"],"summary":"Gets the node denoted by its external id.","operationId":"getNodeByNodeExternalId","parameters":[{"name":"externalId","in":"path","required":true,"schema":{"type":"string"}},{"name":"useTimeSeriesIdentifier","in":"query","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Node"}},"application/hal+json":{"schema":{"$ref":"#/components/schemas/Node"}}}}},"deprecated":true}},"/assets/importable":{"get":{"tags":["Assets"],"summary":"Checks whether or not a new assets structure can be imported.","operationId":"importable","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"boolean"}},"application/hal+json":{"schema":{"type":"boolean"}}}}},"deprecated":true}},"/assets/exportable":{"get":{"tags":["Assets"],"summary":"Checks whether or not the current assets structure can be exported.","operationId":"exportable","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"boolean"}},"application/hal+json":{"schema":{"type":"boolean"}}}}},"deprecated":true}},"/assets/export":{"get":{"tags":["Assets"],"summary":"Exports the current nodes by their structures.","operationId":"export","responses":{"200":{"description":"OK"}},"deprecated":true}},"/assets/browse":{"get":{"tags":["Assets"],"summary":"Lists the structures that have a parent defined by parentId. If parentId is omitted, all root structures are returned.","operationId":"getNodes","parameters":[{"name":"parentId","in":"query","required":false,"schema":{"type":"string","format":"uuid"}},{"name":"useTimeSeriesIdentifier","in":"query","required":false,"schema":{"type":"boolean","default":false}},{"name":"page","in":"query","description":"Zero-based page index (0..N)","schema":{"type":"integer","default":0}},{"name":"size","in":"query","description":"The size of the page to be returned","schema":{"type":"integer","default":20}},{"name":"sort","in":"query","description":"Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedModelStructure"}},"application/hal+json":{"schema":{"$ref":"#/components/schemas/PagedModelStructure"}}}}},"deprecated":true}},"/asset/{path}/accessrule/inherited":{"get":{"tags":["Asset Access Rules"],"summary":"Get all inherited access rule for the specified asset.","operationId":"getInheritedAccessRules_1","parameters":[{"name":"path","in":"path","description":"The identifier of the asset.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AccessRule"}}},"application/hal+json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AccessRule"}}}}},"404":{"description":"The resource was not found","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AccessRule"}}},"application/hal+json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AccessRule"}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AccessRule"}}},"application/hal+json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AccessRule"}}}}}}}},"/asset/{identifier}":{"get":{"tags":["Asset"],"summary":"Get an asset by its identifier.","operationId":"getAsset","parameters":[{"name":"identifier","in":"path","description":"The identifier of the asset.","required":true,"schema":{"type":"string"}},{"name":"useTimeSeriesIdentifier","in":"query","description":"Indicates if the Asset data reference should be resolved to a TimeSeriesIdentifier UUID or not.","required":false,"schema":{"type":"boolean"},"example":true},{"name":"resolveTimeSeriesData","in":"query","description":"Indicates if the timeseries data should be resolved for attributes of type DATAREFERENCE. Default is true","required":false,"schema":{"type":"boolean"},"example":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Asset"}},"application/hal+json":{"schema":{"$ref":"#/components/schemas/Asset"}}}}}}},"/asset/{identifier}/timeseriesdata":{"get":{"tags":["Asset"],"summary":"Get the timeseries data linked to an attribute, identified by its identifier.","operationId":"getTimeseriesData","parameters":[{"name":"identifier","in":"path","description":"The identifier of the attribute.","required":true,"schema":{"type":"string"}},{"name":"useTimeSeriesIdentifier","in":"query","description":"Indicates if the Asset data reference should be resolved to a TimeSeriesIdentifier UUID or not.","required":false,"schema":{"type":"boolean"},"example":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetTimeSeriesData"}},"application/hal+json":{"schema":{"$ref":"#/components/schemas/AssetTimeSeriesData"}}}}}}},"/asset/{identifier}/attribute":{"get":{"tags":["Asset"],"summary":"Get an asset's attributes using the asset's identifier.","operationId":"getAssetAttributes","parameters":[{"name":"identifier","in":"path","description":"The identifier of the asset for which the attributes are searched.","required":true,"schema":{"type":"string"}},{"name":"query","in":"query","description":"You can search on all the exposed properties of a node \n\nAvailable search operators:\nequal(==), not equal(!=), in(=in=), not in(=out=)\n\nAvailable logical operator;\nAND(;), OR(,)\n\nWildcards &#8727 are supported\n\nExamples:\nsearch by name equal to node and description not equal to old: name=='node';description!='old'\n\nsearch by name like node or description equal to something name=='&#8727node&#8727',description=='something'search by name equal to 'node' and node is child of provided parent path 'A.B.C.D' : name=='node';paths=c='A.B.C.D'\n\nsearch by name like 'node' and node is descendant of provided ancestor path 'A.B' : name=='node';paths=d='A.B'","required":false,"schema":{"type":"string"}},{"name":"useTimeSeriesIdentifier","in":"query","description":"Indicates if the Asset data reference should be resolved to a TimeSeriesIdentifier UUID or not.","required":false,"schema":{"type":"boolean"},"example":true},{"name":"resolveTimeSeriesData","in":"query","description":"Indicates if the timeseries data should be resolved for attributes of type DATAREFERENCE. Default is true","required":false,"schema":{"type":"boolean"},"example":true},{"name":"page","in":"query","description":"Zero-based page index (0..N)","schema":{"type":"integer","default":0}},{"name":"size","in":"query","description":"The size of the page to be returned","schema":{"type":"integer","default":20}},{"name":"sort","in":"query","description":"Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedModelAsset"}},"application/hal+json":{"schema":{"$ref":"#/components/schemas/PagedModelAsset"}}}}}}},"/asset/granted-assets":{"get":{"tags":["Granted Asset Permissions"],"summary":"Get all assets for which any permissions is set for the a subject.","operationId":"getGrantedAssets","parameters":[{"name":"subjectType","in":"query","description":"Subject type","required":true,"schema":{"type":"string"}},{"name":"subjectIdentifier","in":"query","description":"Subject identifier","required":false,"schema":{"type":"string"}}],"responses":{"404":{"description":"The requested subject does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GrantedAssetPermissionsRepresentationModel"}},"application/hal+json":{"schema":{"$ref":"#/components/schemas/GrantedAssetPermissionsRepresentationModel"}}}},"204":{"description":"No specific permissions for this user exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GrantedAssetPermissionsRepresentationModel"}},"application/hal+json":{"schema":{"$ref":"#/components/schemas/GrantedAssetPermissionsRepresentationModel"}}}},"200":{"description":"Specific permissions for this user exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GrantedAssetPermissionsRepresentationModel"}},"application/hal+json":{"schema":{"$ref":"#/components/schemas/GrantedAssetPermissionsRepresentationModel"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GrantedAssetPermissionsRepresentationModel"}},"application/hal+json":{"schema":{"$ref":"#/components/schemas/GrantedAssetPermissionsRepresentationModel"}}}}}}},"/asset/granted-assets/subjects":{"get":{"tags":["Granted Asset Permissions"],"summary":"Get all subject type/identifier pairs.","operationId":"getSubjects","responses":{"200":{"description":"All subject type/identifier pairs.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionModelGrantedAssetPermissionsIdRepresentationModel"}},"application/hal+json":{"schema":{"$ref":"#/components/schemas/CollectionModelGrantedAssetPermissionsIdRepresentationModel"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionModelGrantedAssetPermissionsIdRepresentationModel"}},"application/hal+json":{"schema":{"$ref":"#/components/schemas/CollectionModelGrantedAssetPermissionsIdRepresentationModel"}}}}}}},"/asset/browse":{"get":{"tags":["Asset"],"summary":"Browse Asset tree on path","operationId":"browseAsset","parameters":[{"name":"parentPath","in":"query","description":"the ltree path to the asset's parent.","required":false,"schema":{"type":"string"}},{"name":"useTimeSeriesIdentifier","in":"query","description":"Indicates if the Asset data reference should be resolved to a TimeSeriesIdentifier UUID or not.","required":false,"schema":{"type":"boolean"},"example":true},{"name":"resolveTimeSeriesData","in":"query","description":"Indicates if the timeseries data should be resolved for attributes of type DATAREFERENCE. Default is true","required":false,"schema":{"type":"boolean"},"example":true},{"name":"page","in":"query","description":"Zero-based page index (0..N)","schema":{"type":"integer","default":0}},{"name":"size","in":"query","description":"The size of the page to be returned","schema":{"type":"integer","default":20}},{"name":"sort","in":"query","description":"Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedModelAsset"}},"application/hal+json":{"schema":{"$ref":"#/components/schemas/PagedModelAsset"}}}}}}},"/asset/accessrule":{"get":{"tags":["Asset Access Rules"],"summary":"Returns true if there are any other permissions then the default permissions.","operationId":"checkDefaultAccessPermissionsModified","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessPermissionsModifiedRepresentationModel"}},"application/hal+json":{"schema":{"$ref":"#/components/schemas/AccessPermissionsModifiedRepresentationModel"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessPermissionsModifiedRepresentationModel"}},"application/hal+json":{"schema":{"$ref":"#/components/schemas/AccessPermissionsModifiedRepresentationModel"}}}}}}},"/asset/accessrule/modified":{"get":{"tags":["Asset Access Rules"],"summary":"Returns access rules collection which were modified after input","operationId":"getAccessRulesModifiedAfter","parameters":[{"name":"modifiedAfter","in":"query","description":"Timestamp to filter rules modified after the given modifiedAfter timestamp","required":true,"schema":{"type":"string","format":"date-time"}},{"name":"lastCheckedId","in":"query","description":"UUID of last synchronized rule to be used as tiebreaker when modified timestamps match","required":false,"schema":{"type":"string","format":"uuid"}},{"name":"size","in":"query","description":"number of records returned in 1 page","required":false,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedModelAccessRule"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedModelAccessRule"}}}}}}},"/asset/accessrule/deleted":{"get":{"tags":["Asset Access Rules"],"summary":"Returns ids of access rules collection which were deleted after the given deletedAfter timestamp","operationId":"getAccessRulesDeletedAfter","parameters":[{"name":"deletedAfter","in":"query","description":"Timestamp to filter rules deleted after","required":true,"schema":{"type":"string","format":"date-time"}},{"name":"lastCheckedId","in":"query","description":"UUID of last synchronized rule to be used as tiebreaker when modified timestamps match","required":false,"schema":{"type":"string","format":"uuid"}},{"name":"size","in":"query","description":"number of records returned in 1 page","required":false,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedModelDeletedAccessRule"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedModelDeletedAccessRule"}}}}}}}},"components":{"schemas":{"Link":{"type":"object","properties":{"rel":{"type":"string"},"href":{"type":"string"},"hreflang":{"type":"string"},"media":{"type":"string"},"title":{"type":"string"},"type":{"type":"string"},"deprecation":{"type":"string"},"profile":{"type":"string"},"name":{"type":"string"}}},"Source":{"type":"object","properties":{"identifier":{"type":"string","description":"The source's identifier.","format":"uuid"},"name":{"type":"string","description":"The source's name."},"type":{"type":"string","description":"The source's type.","enum":["DATASOURCE","CSV"]},"externalId":{"type":"string","description":"The source's external identifier."},"ordering":{"type":"integer","description":"The source's order in the root asset tree.","format":"int32"},"published":{"type":"boolean","description":"Indicates whether he source is published."},"lastSyncDate":{"type":"string","description":"Indicates whether he source is published.","format":"date-time"},"permissions":{"uniqueItems":true,"type":"array","description":"The source's permissions for the requesting user.","items":{"type":"string","description":"Represents all permissions available in the Assets domain.","enum":["ASSET_NO_PERMISSIONS","ASSET_BROWSE","ASSET_READ_CONTEXT_ITEM"]}},"links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}}},"description":"Represents a source"},"NodeBuilderModel":{"required":["name","parentPath"],"type":"object","properties":{"parentPath":{"type":"string","description":"Parent node's short path."},"name":{"type":"string","description":"Node's name."},"description":{"type":"string","description":"Node's description."},"tag":{"type":"string","description":"Tag the ATTRIBUTE refers to."}},"description":"Represents a model to build an asset tree"},"NodeBuilderRepresentationModel":{"required":["description","name"],"type":"object","properties":{"identifier":{"type":"string","description":"Node's identifier.","format":"uuid"},"sourceIdentifier":{"type":"string","description":"Source's identifier.","format":"uuid"},"parentPath":{"type":"string","description":"Parent node's path."},"name":{"type":"string","description":"Node's name."},"description":{"type":"string","description":"Node's description."},"tag":{"type":"string","description":"Tag the ATTRIBUTE refers to."},"links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}}},"description":"Represents a node in the asset tree builder"},"AssetAccessRuleModel":{"required":["permissions","subjectId","subjectType"],"type":"object","properties":{"identifier":{"type":"string","description":"The identifier of the access rule."},"subjectId":{"type":"string","description":"The identifier of the subject."},"subjectType":{"type":"string","description":"The type of the subject.","enum":["GUEST","EVERYONE","GROUP","USER"]},"permissions":{"uniqueItems":true,"type":"array","description":"A set of permissions the subject has on the specified object.","items":{"type":"string","description":"Represents all permissions available in the Assets domain.","enum":["ASSET_NO_PERMISSIONS","ASSET_BROWSE","ASSET_READ_CONTEXT_ITEM"]}}},"description":"Object used for creating and updating an access rule"},"AccessRule":{"required":["objectId","paths","permissions","subjectId","subjectType"],"type":"object","properties":{"identifier":{"type":"string","description":"The identifier of the access rule."},"objectId":{"type":"string","description":"The identifier of the object."},"paths":{"type":"array","description":"An array of paths towards the object.","items":{"type":"string","description":"An array of paths towards the object."}},"subjectId":{"type":"string","description":"The identifier of the subject."},"subjectType":{"type":"string","description":"The type of the subject: USER, GROUP, EVERYBODY, GUEST.","enum":["GUEST","EVERYONE","GROUP","USER"]},"permissions":{"uniqueItems":true,"type":"array","description":"A set of permissions the subject has on the specified object. Can be an empty set.","items":{"type":"string","description":"Represents all permissions available in the Assets domain.","enum":["ASSET_NO_PERMISSIONS","ASSET_BROWSE","ASSET_READ_CONTEXT_ITEM"]}},"userDetailsResource":{"$ref":"#/components/schemas/UserDetails"},"structureResource":{"$ref":"#/components/schemas/Structure"},"assetResource":{"$ref":"#/components/schemas/Asset"},"createdDate":{"type":"string","description":"Access rule creation date","format":"date-time"},"lastModifiedDate":{"type":"string","description":"Access rule last modified date","format":"date-time"},"links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}}},"description":"Represents an access rule definition"},"Asset":{"type":"object","properties":{"identifier":{"type":"string","description":"The asset's identifier.","format":"uuid"},"paths":{"type":"array","description":"The paths towards this asset starting from the root.","items":{"type":"string","description":"The paths towards this asset starting from the root."}},"longPaths":{"type":"array","description":"The old longer paths towards this asset starting from the root.","deprecated":true,"items":{"type":"string","description":"The old longer paths towards this asset starting from the root."}},"parentNames":{"type":"array","description":"The names of the parents, in the same order as the paths.","items":{"type":"string","description":"The names of the parents, in the same order as the paths."}},"name":{"type":"string","description":"The asset's name."},"description":{"type":"string","description":"The asset's description."},"type":{"type":"string","description":"The asset's type."},"dataType":{"type":"string","description":"The asset's data type, if the Asset is an ATTRIBUTE."},"data":{"type":"string","description":"The asset's data, if the Asset is an ATTRIBUTE. (tagName or UUID)"},"timeSeriesDefinition":{"$ref":"#/components/schemas/TimeSeriesDefinitionRepresentation"},"deleted":{"type":"boolean","description":"Indication whether this asset is deleted or not."},"externalId":{"type":"string","description":"The asset's identifier in the external system."},"template":{"type":"string","description":"The asset's template."},"templateId":{"type":"string","description":"The asset's template identifier."},"source":{"$ref":"#/components/schemas/Source"},"permissions":{"uniqueItems":true,"type":"array","description":"The asset's permissions.","items":{"type":"string","description":"Represents all permissions available in the Assets domain.","enum":["ASSET_NO_PERMISSIONS","ASSET_BROWSE","ASSET_READ_CONTEXT_ITEM"]}},"createdDate":{"type":"string","description":"The asset's creation date","format":"date-time"},"lastModifiedDate":{"type":"string","description":"The asset's last modified date","format":"date-time"},"links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}}},"description":"Represents an asset"},"Structure":{"type":"object","properties":{"structureIdentifier":{"type":"string"},"sourceId":{"type":"string"},"parentStructureId":{"type":"string"},"nodeIdentifier":{"type":"string"},"type":{"type":"string"},"externalId":{"type":"string"},"template":{"type":"string"},"templateId":{"type":"string"},"name":{"type":"string"},"parentName":{"type":"string"},"description":{"type":"string"},"dataType":{"type":"string"},"data":{"type":"string"},"options":{"type":"string"},"deleted":{"type":"boolean"},"path":{"type":"string"},"permissions":{"uniqueItems":true,"type":"array","items":{"type":"string","description":"Represents all permissions available in the Assets domain.","enum":["ASSET_NO_PERMISSIONS","ASSET_BROWSE","ASSET_READ_CONTEXT_ITEM"]}},"links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}}},"description":"Structure details for enriched inherited calls."},"TimeSeriesDefinitionRepresentation":{"type":"object","properties":{"datasourceId":{"type":"string","format":"uuid"},"ownerId":{"type":"string"},"externalId":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"type":{"type":"string"},"units":{"type":"string"},"interpolationType":{"type":"string"},"datasourceType":{"type":"string"},"deleted":{"type":"boolean"},"plotDataUrl":{"type":"string"},"indexDataUrl":{"type":"string"},"links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}},"id":{"type":"string","format":"uuid"}},"description":"TimeSeries definition to which the data points. Can be empty, even if data is present."},"UserDetails":{"type":"object","properties":{"userId":{"type":"string","description":"User's id."},"userName":{"type":"string","description":"User's username."},"firstName":{"type":"string","description":"User's first name."},"lastName":{"type":"string","description":"User's last name."},"admin":{"type":"boolean","description":"Indication whether user is an admin or not."}},"description":"Represents a subset of user details"},"SourceSyncJob":{"type":"object","properties":{"source":{"$ref":"#/components/schemas/Source"},"syncJob":{"$ref":"#/components/schemas/SyncJob"}}},"SyncJob":{"type":"object","properties":{"identifier":{"type":"string","description":"The sync job's identifier.","format":"uuid"},"name":{"type":"string","description":"The sync job's name."},"started":{"type":"string","description":"The moment the sync job started.","format":"date-time"},"ended":{"type":"string","description":"The moment the sync job ended.","format":"date-time"},"status":{"type":"string","description":"The sync job's status.","enum":["SCHEDULED","RUNNING","DONE","DONE_WITH_ERRORS","CANCELLED","FAILED"]},"triggeredDate":{"type":"string","description":"The moment the sync job was triggered.","format":"date-time"},"triggeredBy":{"type":"string","description":"The user the sync job triggered by."},"errorMessage":{"type":"string","description":"The sync job's error message, if any."},"source":{"$ref":"#/components/schemas/Source"},"links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}}}},"IdListModel":{"type":"object","properties":{"uuidList":{"type":"array","description":"List of asset identifiers.","items":{"type":"string","description":"List of asset identifiers.","format":"uuid"}}}},"GrantedPermissionMap":{"type":"object","properties":{"permissions":{"type":"object","additionalProperties":{"uniqueItems":true,"type":"array","description":"Map of granted permissions per node/structure id.","items":{"type":"string","description":"Map of granted permissions per node/structure id."}},"description":"Map of granted permissions per node/structure id."}},"description":"Represents granted permissions for bulk permission resolving"},"SourceReorderingModel":{"type":"object","properties":{"operation":{"type":"string","enum":["UP","DOWN","TOP","BOTTOM"]}}},"GrantedPermission":{"type":"object","properties":{"assetIdentifier":{"type":"string","format":"uuid"},"sourceIdentifier":{"type":"string","format":"uuid"},"permissions":{"uniqueItems":true,"type":"array","items":{"type":"string"}}},"description":"List of granted permissions"},"GrantedPermissions":{"type":"object","properties":{"permissions":{"type":"array","description":"List of granted permissions","items":{"$ref":"#/components/schemas/GrantedPermission"}}},"description":"Represents granted permissions for an Asset"},"LinkModel":{"required":["link"],"type":"object","properties":{"link":{"type":"string","description":"The requested link."},"validity":{"type":"integer","description":"Validity of the requested token, in seconds.","format":"int64","default":30}}},"DataModel":{"type":"object","properties":{"data":{"type":"string","description":"the signed link data"}}},"SourceBuilderModel":{"required":["name"],"type":"object","properties":{"name":{"type":"string","description":"The name of the source."},"published":{"type":"boolean","description":"Indicator whether the source is published or not."}},"description":"Represents a model to create an asset tree"},"PathListModel":{"type":"object","properties":{"pathList":{"type":"array","items":{"type":"string"}}}},"SearchParametersV1Model":{"required":["query"],"type":"object","properties":{"query":{"type":"string","description":"value = \"You can search on all the exposed properties of an asset.\\n\\n\" +\n                            \"Available search operators:\\n\" +\n                            \"equal(==), not equal(!=), in(=in=), not in(=out=)\\n\" +\n                            \"\\n\" +\n                            \"Available search operators for 'paths' property :\\n\" +\n                            \"child of (=c= or =child=), descendant of (=d= or =descendant=)\\n\" +\n                            \"\\n\" +\n                            \"Available logical operator;\\n\" +\n                            \"AND(;), OR(,)\\n\" +\n                            \"\\n\" +\n                            \"Wildcards &#8727 are supported\\n\\n\" +\n                            \"Examples:\\n\" +\n                            \"search by name equal to 'node' and description not equal to 'old': name=='node';description!='old'\\n\\n\" +\n                            \"search by name like 'node' or description equal to 'something': name=='&#8727node&#8727',description=='something'\\n\\n\" +\n                            \"search by name equal to 'node' and node is child of provided parent path 'A.B.C.D' : name=='node';paths=c='A.B.C.D'\\n\\n\" +\n                            \"search by name like 'node' and node is descendant of provided ancestor path 'A.B' : name=='node';paths=d='A.B'\"","example":"name=='*End',name=='Start*'"},"page":{"type":"integer","format":"int32","writeOnly":true},"size":{"type":"integer","format":"int32","writeOnly":true},"sort":{"type":"array","writeOnly":true,"items":{"type":"string"}},"useTimeSeriesIdentifier":{"type":"boolean","description":"Indicates if the Asset data reference should be resolved to a TimeSeriesIdentifier UUID or not. Default is true","example":true},"unnest":{"type":"boolean","description":"Unnest asset with multiple paths or not.","example":true},"includeDeleted":{"type":"boolean","description":"Defines, if deleted nodes should be shown.","example":false},"resolveTimeSeriesData":{"type":"boolean","description":"Indicates if the timeseries data should be resolved for attributes of type DATAREFERENCE. Default is true","example":true},"parent":{"type":"string","description":"the uuid of the parent structure.","example":"8583f23c-6684-48ef-8182-cc8d66f95f66"}},"description":"Represents search parameters for assetsV1"},"PageMetadata":{"type":"object","properties":{"size":{"type":"integer","format":"int64"},"totalElements":{"type":"integer","format":"int64"},"totalPages":{"type":"integer","format":"int64"},"number":{"type":"integer","format":"int64"}}},"PagedModelStructure":{"type":"object","properties":{"links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}},"content":{"type":"array","items":{"$ref":"#/components/schemas/Structure"}},"page":{"$ref":"#/components/schemas/PageMetadata"}}},"Node":{"type":"object","properties":{"identifier":{"type":"string","description":"The node's identifier"},"sourceId":{"type":"string","description":"Deprecated notion of source.","deprecated":true},"type":{"type":"string","description":"Node's type."},"externalId":{"type":"string","description":"Node's external identifier."},"template":{"type":"string","description":"Node's template name."},"templateId":{"type":"string","description":"Node's template identifier."},"name":{"type":"string","description":"Node's name."},"description":{"type":"string","description":"Node's description."},"dataType":{"type":"string","description":"Node's data type in case this node is an ATTRIBUTE."},"data":{"type":"string","description":"Node's data in case this node is an ATTRIBUTE."},"timeSeriesDefinition":{"$ref":"#/components/schemas/TimeSeriesDefinitionRepresentation"},"options":{"type":"string","description":"Node's options."},"deleted":{"type":"boolean","description":"Idicates whether this node is deleted."},"permissions":{"uniqueItems":true,"type":"array","description":"Node's permission for the requesting user.","items":{"type":"string","description":"Represents all permissions available in the Assets domain.","enum":["ASSET_NO_PERMISSIONS","ASSET_BROWSE","ASSET_READ_CONTEXT_ITEM"]}},"paths":{"type":"array","description":"The paths towards this asset starting from the root.","items":{"type":"string","description":"The paths towards this asset starting from the root."}},"longPaths":{"type":"array","description":"The old longer paths towards this asset starting from the root.","deprecated":true,"items":{"type":"string","description":"The old longer paths towards this asset starting from the root."}},"links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}}}},"NamedPathListModel":{"type":"object","properties":{"namedPathList":{"type":"array","description":"List of paths built up using asset names.","items":{"type":"string","description":"List of paths built up using asset names."}}}},"Mapping":{"type":"object","properties":{"path":{"type":"string","description":"Path of the asset."},"identifier":{"type":"string","description":"Identifier of the asset."}},"description":"List of mappings."},"Mappings":{"type":"object","properties":{"mappings":{"type":"array","description":"List of mappings.","items":{"$ref":"#/components/schemas/Mapping"}},"links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}}}},"NodeSearchParametersModel":{"required":["query"],"type":"object","properties":{"query":{"type":"string","description":"value = \"You can search on all the exposed properties of an asset.\\n\\n\" +\n                            \"Available search operators:\\n\" +\n                            \"equal(==), not equal(!=), in(=in=), not in(=out=)\\n\" +\n                            \"\\n\" +\n                            \"Available search operators for 'paths' property :\\n\" +\n                            \"child of (=c= or =child=), descendant of (=d= or =descendant=)\\n\" +\n                            \"\\n\" +\n                            \"Available logical operator;\\n\" +\n                            \"AND(;), OR(,)\\n\" +\n                            \"\\n\" +\n                            \"Wildcards &#8727 are supported\\n\\n\" +\n                            \"Examples:\\n\" +\n                            \"search by name equal to 'node' and description not equal to 'old': name=='node';description!='old'\\n\\n\" +\n                            \"search by name like 'node' or description equal to 'something': name=='&#8727node&#8727',description=='something'\\n\\n\" +\n                            \"search by name equal to 'node' and node is child of provided parent path 'A.B.C.D' : name=='node';paths=c='A.B.C.D'\\n\\n\" +\n                            \"search by name like 'node' and node is descendant of provided ancestor path 'A.B' : name=='node';paths=d='A.B'\"","example":"name=='*End',name=='Start*'"},"page":{"type":"integer","format":"int32","writeOnly":true},"size":{"type":"integer","format":"int32","writeOnly":true},"sort":{"type":"array","writeOnly":true,"items":{"type":"string"}},"useTimeSeriesIdentifier":{"type":"boolean","description":"Indicates if the Asset data reference should be resolved to a TimeSeriesIdentifier UUID or not. Default is true","example":true},"unnest":{"type":"boolean","description":"Unnest asset with multiple paths or not.","example":true},"includeDeleted":{"type":"boolean","description":"Defines, if deleted nodes should be shown.","example":false},"resolveTimeSeriesData":{"type":"boolean","description":"Indicates if the timeseries data should be resolved for attributes of type DATAREFERENCE. Default is true","example":true}},"description":"Represents search parameters"},"PagedModelAsset":{"type":"object","properties":{"links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}},"content":{"type":"array","items":{"$ref":"#/components/schemas/Asset"}},"page":{"$ref":"#/components/schemas/PageMetadata"}}},"RelativesByPathModel":{"type":"object","properties":{"path":{"type":"string","description":"Path of the asset"},"include":{"type":"string","description":"Type to include","enum":["SELF","ANCESTORS","DESCENDANTS"]}}},"MappingV2":{"type":"object","properties":{"namedPath":{"type":"string","description":"Path of the asset."},"identifier":{"type":"string","description":"Identifier of the asset."},"longPath":{"type":"string","description":"Path of identifiers to the asset."},"path":{"type":"string","description":"Path of short identifiers to the asset."}},"description":"List of mappings."},"MappingsV2":{"type":"object","properties":{"mappings":{"type":"array","description":"List of mappings.","items":{"$ref":"#/components/schemas/MappingV2"}},"links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}}}},"PagedModelSyncJob":{"type":"object","properties":{"links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}},"content":{"type":"array","items":{"$ref":"#/components/schemas/SyncJob"}},"page":{"$ref":"#/components/schemas/PageMetadata"}}},"PagedModelSource":{"type":"object","properties":{"links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}},"content":{"type":"array","items":{"$ref":"#/components/schemas/Source"}},"page":{"$ref":"#/components/schemas/PageMetadata"}}},"PagedModelNode":{"type":"object","properties":{"links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}},"content":{"type":"array","items":{"$ref":"#/components/schemas/Node"}},"page":{"$ref":"#/components/schemas/PageMetadata"}}},"AssetTimeSeriesData":{"type":"object","properties":{"data":{"type":"string"},"timeseriesDefinition":{"$ref":"#/components/schemas/TimeSeriesDefinitionRepresentation"},"links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}}}},"GrantedAssetPermissionsRepresentationModel":{"type":"object","properties":{"assetIdentifiers":{"type":"array","items":{"type":"string","format":"uuid"}},"subjectIdentifier":{"type":"string"},"subjectType":{"type":"string"},"links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}}},"description":"Model holding a list of asset identifiers for which the user has any permission."},"CollectionModelGrantedAssetPermissionsIdRepresentationModel":{"type":"object","properties":{"links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}},"content":{"type":"array","items":{"$ref":"#/components/schemas/GrantedAssetPermissionsIdRepresentationModel"}}}},"GrantedAssetPermissionsIdRepresentationModel":{"type":"object","properties":{"subjectType":{"type":"string","description":"The subject's type."},"subjectIdentifier":{"type":"string","description":"The subject's identifier."},"links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}}},"description":"Represents a granted asset permission identifier."},"AccessPermissionsModifiedRepresentationModel":{"type":"object","properties":{"modified":{"type":"boolean"}}},"PagedModelAccessRule":{"type":"object","properties":{"links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}},"content":{"type":"array","items":{"$ref":"#/components/schemas/AccessRule"}},"page":{"$ref":"#/components/schemas/PageMetadata"}}},"DeletedAccessRule":{"type":"object","properties":{"identifier":{"type":"string","description":"The identifier of the access rule.","format":"uuid"},"deletedAt":{"type":"string","description":"The date of deletion of the access rule.","format":"date-time"},"links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}}},"description":"Represents a deleted access rule"},"PagedModelDeletedAccessRule":{"type":"object","properties":{"links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}},"content":{"type":"array","items":{"$ref":"#/components/schemas/DeletedAccessRule"}},"page":{"$ref":"#/components/schemas/PageMetadata"}}}},"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"},"openIdConnect":{"type":"openIdConnect","openIdConnectUrl":"https://tm-toggles-next.trendminer.net/auth/realms/trendminer/.well-known/openid-configuration"}}}}