docs/1.0.0/swagger.json

{"swagger":"2.0","info":{"version":"1.0","title":"Eclipse Kapua REST API"},"basePath":"/v1","tags":[{"name":"Access Info"},{"name":"Accounts"},{"name":"Authentication"},{"name":"Credentials"},{"name":"Data Channels"},{"name":"Data Clients"},{"name":"Data Messages"},{"name":"Data Metrics"},{"name":"Device Connections"},{"name":"Devices"},{"name":"Domains"},{"name":"EndpointInfos"},{"name":"Groups"},{"name":"Roles"},{"name":"Streams"},{"name":"Tags"},{"name":"Users"}],"schemes":["http"],"paths":{"/{scopeId}/accessinfos":{"get":{"tags":["Access Info"],"summary":"Gets the AccessInfo list in the scope.","description":"Gets the AccessInfo list in the scope. The query parameter userId is optional and can be used to filter results","operationId":"accessInfoSimpleQuery","produces":["application/json","application/xml"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId in which to search results","required":true,"type":"string","default":"_"},{"name":"userId","in":"query","description":"The optional User id to filter results","required":false,"type":"string"},{"name":"offset","in":"query","description":"The result set offset","required":false,"type":"integer","default":0,"format":"int32"},{"name":"limit","in":"query","description":"The result set limit","required":false,"type":"integer","default":50,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AccessInfoListResult"}}},"security":[{"kapuaAccessToken":[]}]},"post":{"tags":["Access Info"],"summary":"Creates a new AccessInfo","description":"Creates a new AccessInfo based on the information provided in AccessInfoCreator parameter","operationId":"accessInfoCreate","consumes":["application/xml","application/json"],"produces":["application/xml","application/json"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId in which to create the AccessInfo","required":true,"type":"string","default":"_"},{"in":"body","name":"body","description":"Provides the information for the new AccessInfo to be created","required":true,"schema":{"$ref":"#/definitions/AccessInfoCreator"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AccessInfo"}}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/accessinfos/{accessInfoId}":{"get":{"tags":["Access Info"],"summary":"Gets an AccessInfo","description":"Gets the AccessInfo specified by the accessInfoId path parameter","operationId":"accessInfoFind","produces":["application/json","application/xml"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId of the requested AccessInfo.","required":true,"type":"string","default":"_"},{"name":"accessInfoId","in":"path","description":"The id of the requested AccessInfo","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AccessInfo"}}},"security":[{"kapuaAccessToken":[]}]},"delete":{"tags":["Access Info"],"summary":"Deletes an AccessInfo","description":"Deletes the AccessInfo specified by the accessInfoId path parameter","operationId":"accessInfoDelete","parameters":[{"name":"scopeId","in":"path","description":"The ScopeId in which to create the AccessInfo","required":true,"type":"string","default":"_"},{"name":"accessInfoId","in":"path","description":"The id of the AccessInfo to delete","required":true,"type":"string"}],"responses":{"default":{"description":"successful operation"}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/accessinfos/_count":{"post":{"tags":["Access Info"],"summary":"Counts the AccessInfos","description":"Counts the AccessInfos with the given AccessInfoQuery parameter returning the number of matching AccessInfos","operationId":"accessInfoCount","consumes":["application/xml","application/json"],"produces":["application/xml","application/json"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId in which to count results","required":true,"type":"string","default":"_"},{"in":"body","name":"body","description":"The AccessInfoQuery to use to filter count results","required":true,"schema":{"$ref":"#/definitions/AccessInfoQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CountResult"}}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/accessinfos/_query":{"post":{"tags":["Access Info"],"summary":"Queries the AccessInfos","description":"Queries the AccessInfos with the given AccessInfoQuery parameter returning all matching AccessInfos","operationId":"accessInfoQuery","consumes":["application/xml","application/json"],"produces":["application/xml","application/json"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId in which to search results","required":true,"type":"string","default":"_"},{"in":"body","name":"body","description":"The AccessInfoQuery to use to filter results","required":true,"schema":{"$ref":"#/definitions/AccessInfoQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AccessInfoListResult"}}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/accessinfos/{accessInfoId}/permissions":{"get":{"tags":["Access Info"],"summary":"Gets the AccessPermission list in the scope","description":"Gets the AccessPermission list in the scope. The query parameter accessInfoId is optional and can be used to filter results","operationId":"accessPermissionSimpleQuery","produces":["application/json","application/xml"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId in which to search results.","required":true,"type":"string","default":"_"},{"name":"accessInfoId","in":"path","description":"The optional id to filter results.","required":true,"type":"string"},{"name":"offset","in":"query","description":"The result set offset.","required":false,"type":"integer","default":0,"format":"int32"},{"name":"limit","in":"query","description":"The result set limit.","required":false,"type":"integer","default":50,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AccessPermissionListResult"}}},"security":[{"kapuaAccessToken":[]}]},"post":{"tags":["Access Info"],"summary":"Create an AccessPermission","description":"Creates a new AccessPermission based on the information provided in AccessPermissionCreator parameter.","operationId":"accessPermissionCreate","consumes":["application/xml","application/json"],"produces":["application/xml","application/json"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId in which to create the AccessPermission","required":true,"type":"string","default":"_"},{"name":"accessInfoId","in":"path","description":"The AccessInfo id in which to create the AccessPermission.","required":true,"type":"string"},{"in":"body","name":"body","description":"Provides the information for the new AccessPermission to be created","required":true,"schema":{"$ref":"#/definitions/AccessPermissionCreator"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AccessPermission"}}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/accessinfos/{accessInfoId}/permissions/{accessPermissionId}":{"get":{"tags":["Access Info"],"summary":"Get an AccessPermission","description":"Returns the AccessPermission specified by the \"accessPermissionId\" path parameter.","operationId":"accessPermissionFind","produces":["application/json","application/xml"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId of the requested AccessPermission.","required":true,"type":"string","default":"_"},{"name":"accessInfoId","in":"path","description":"Specifies the AccessPermissionId for the requested AccessPermission","required":true,"type":"string"},{"name":"accessPermissionId","in":"path","description":"The id of the requested AccessPermission","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AccessPermission"}}},"security":[{"kapuaAccessToken":[]}]},"delete":{"tags":["Access Info"],"summary":"Delete an AccessPermission","description":"Deletes the AccessPermission specified by the \"accessPermissionId\" path parameter.","operationId":"accessPermissionDelete","parameters":[{"name":"scopeId","in":"path","description":"The ScopeId of the AccessPermission to delete.","required":true,"type":"string","default":"_"},{"name":"accessInfoId","in":"path","description":"Specifies the AccessInfo Id for the requested AccessPermission","required":true,"type":"string"},{"name":"accessPermissionId","in":"path","description":"The id of the AccessPermission to be deleted","required":true,"type":"string"}],"responses":{"default":{"description":"successful operation"}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/accessinfos/{accessInfoId}/permissions/_count":{"post":{"tags":["Access Info"],"summary":"Counts the AccessPermissions","description":"Counts the AccessPermissions with the given AccessPermissionQuery parameter returning the number of matching AccessPermissions","operationId":"accessPermissionCount","consumes":["application/xml","application/json"],"produces":["application/xml","application/json"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId in which to count results","required":true,"type":"string","default":"_"},{"name":"accessInfoId","in":"path","description":"The AccessInfo id in which to count results.","required":true,"type":"string"},{"in":"body","name":"body","description":"The AccessPermissionQuery to use to filter count results","required":true,"schema":{"$ref":"#/definitions/AccessPermissionQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CountResult"}}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/accessinfos/{accessInfoId}/permissions/_query":{"post":{"tags":["Access Info"],"summary":"Queries the AccessPermissions","description":"Queries the AccessPermissions with the given AccessPermissionQuery parameter returning all matching AccessPermissions","operationId":"accessPermissionQuery","consumes":["application/xml","application/json"],"produces":["application/xml","application/json"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId in which to search results.","required":true,"type":"string","default":"_"},{"name":"accessInfoId","in":"path","description":"The AccessInfo id in which to search results.","required":true,"type":"string"},{"in":"body","name":"body","description":"The AccessPermissionQuery to use to filter results.","required":true,"schema":{"$ref":"#/definitions/AccessPermissionQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AccessPermissionListResult"}}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/accessinfos/{accessInfoId}/roles":{"get":{"tags":["Access Info"],"summary":"Gets the AccessRole list in the scope","description":"Returns the list of all the accessRoles associated to the current selected scope.","operationId":"accessRoleSimpleQuery","produces":["application/json","application/xml"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId in which to search results.","required":true,"type":"string","default":"_"},{"name":"accessInfoId","in":"path","description":"The optional id to filter results.","required":true,"type":"string"},{"name":"offset","in":"query","description":"The result set offset.","required":false,"type":"integer","default":0,"format":"int32"},{"name":"limit","in":"query","description":"The result set limit.","required":true,"type":"integer","default":50,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AccessRoleListResult"}}},"security":[{"kapuaAccessToken":[]}]},"post":{"tags":["Access Info"],"summary":"Create an AccessRole","description":"Creates a new AccessRole based on the information provided in AccessRoleCreator parameter.","operationId":"accessRoleCreate","consumes":["application/xml","application/json"],"produces":["application/xml","application/json"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId in which to create the AccessRole","required":true,"type":"string","default":"_"},{"name":"accessInfoId","in":"path","description":"The AccessInfo id in which to create the AccessRole.","required":true,"type":"string"},{"in":"body","name":"body","description":"Provides the information for the new AccessRole to be created","required":true,"schema":{"$ref":"#/definitions/AccessRoleCreator"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AccessRole"}}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/accessinfos/{accessInfoId}/roles/{accessRoleId}":{"get":{"tags":["Access Info"],"summary":"Get an AccessRole","description":"Returns the AccessRole specified by the \"accessRoleId\" path parameter.","operationId":"accessRoleFind","produces":["application/json","application/xml"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId of the requested AccessRole.","required":true,"type":"string","default":"_"},{"name":"accessInfoId","in":"path","description":"Specifies the AccessRoleId for the requested AccessRole","required":true,"type":"string"},{"name":"accessRoleId","in":"path","description":"The id of the requested AccessRole","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AccessRole"}}},"security":[{"kapuaAccessToken":[]}]},"delete":{"tags":["Access Info"],"summary":"Delete an AccessRole","description":"Deletes the AccessRole specified by the \"accessRoleId\" path parameter.","operationId":"accessRoleDelete","parameters":[{"name":"scopeId","in":"path","description":"The ScopeId of the AccessRole to delete.","required":true,"type":"string","default":"_"},{"name":"accessInfoId","in":"path","description":"Specifies the AccessInfoId for the requested AccessPermission","required":true,"type":"string"},{"name":"accessRoleId","in":"path","description":"The id of the AccessRole to be deleted","required":true,"type":"string"}],"responses":{"default":{"description":"successful operation"}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/accessinfos/{accessInfoId}/roles/_count":{"post":{"tags":["Access Info"],"summary":"Counts the AccessRoles","description":"Counts the AccessRoles with the given AccessRoleQuery parameter returning the number of matching AccessRoles","operationId":"accessRoleCount","consumes":["application/xml","application/json"],"produces":["application/xml","application/json"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId in which to count results","required":true,"type":"string","default":"_"},{"name":"accessInfoId","in":"path","description":"The AccessInfo id in which to count results.","required":true,"type":"string"},{"in":"body","name":"body","description":"The AccessRoleQuery to use to filter count results","required":true,"schema":{"$ref":"#/definitions/AccessRoleQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CountResult"}}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/accessinfos/{accessInfoId}/roles/_query":{"post":{"tags":["Access Info"],"summary":"Queries the AccessRoles","description":"Queries the AccessRoles with the given AccessRoleQuery parameter returning all matching AccessRoles","operationId":"accessRoleQuery","consumes":["application/xml","application/json"],"produces":["application/xml","application/json"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId in which to search results.","required":true,"type":"string","default":"_"},{"name":"accessInfoId","in":"path","description":"The AccessInfo id in which to search results.","required":true,"type":"string"},{"in":"body","name":"body","description":"The AccessRoleQuery to use to filter results.","required":true,"schema":{"$ref":"#/definitions/AccessRoleQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AccessRoleListResult"}}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/accounts":{"get":{"tags":["Accounts"],"summary":"Gets the Account list in the scope","description":"Returns the list of all the accounts associated to the current selected scope.","operationId":"accountSimpleQuery","produces":["application/json","application/xml"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId in which to search results.","required":true,"type":"string","default":"_"},{"name":"name","in":"query","description":"The account name to filter results.","required":false,"type":"string"},{"name":"offset","in":"query","description":"The result set offset.","required":false,"type":"integer","default":0,"format":"int32"},{"name":"limit","in":"query","description":"The result set limit.","required":false,"type":"integer","default":50,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AccountListResult"}}},"security":[{"kapuaAccessToken":[]}]},"post":{"tags":["Accounts"],"summary":"Create an Account","description":"Creates a new Account based on the information provided in AccountCreator parameter.","operationId":"accountCreate","consumes":["application/xml","application/json"],"produces":["application/xml","application/json"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId in which to create the Account","required":true,"type":"string","default":"_"},{"in":"body","name":"body","description":"Provides the information for the new Account to be created","required":true,"schema":{"$ref":"#/definitions/AccountCreator"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Account"}}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/accounts/{accountId}":{"get":{"tags":["Accounts"],"summary":"Get an Account","description":"Returns the Account specified by the \"accountId\" path parameter.","operationId":"accountFind","produces":["application/json","application/xml"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId of the requested Account.","required":true,"type":"string","default":"_"},{"name":"accountId","in":"path","description":"The id of the requested Account","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Account"}}},"security":[{"kapuaAccessToken":[]}]},"put":{"tags":["Accounts"],"summary":"Update an Account","description":"Updates a new Account based on the information provided in the Account parameter.","operationId":"accountUpdate","consumes":["application/xml","application/json"],"produces":["application/xml","application/json"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId of the requested Account.","required":true,"type":"string","default":"_"},{"name":"accountId","in":"path","description":"The id of the requested Account","required":true,"type":"string"},{"in":"body","name":"body","description":"The modified Account whose attributes needs to be updated","required":true,"schema":{"$ref":"#/definitions/Account"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Account"}}},"security":[{"kapuaAccessToken":[]}]},"delete":{"tags":["Accounts"],"summary":"Delete an Account","description":"Deletes the Account specified by the \"accountId\" path parameter.","operationId":"accountDelete","parameters":[{"name":"scopeId","in":"path","description":"The ScopeId of the Account to delete.","required":true,"type":"string","default":"_"},{"name":"accountId","in":"path","description":"The id of the Account to be deleted","required":true,"type":"string"}],"responses":{"default":{"description":"successful operation"}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/accounts/_count":{"post":{"tags":["Accounts"],"summary":"Counts the Accounts","description":"Counts the Accounts with the given AccountQuery parameter returning the number of matching Accounts","operationId":"accountCount","consumes":["application/xml","application/json"],"produces":["application/xml","application/json"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId in which to count results","required":true,"type":"string","default":"_"},{"in":"body","name":"body","description":"The AccountQuery to use to filter count results","required":true,"schema":{"$ref":"#/definitions/AccountQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CountResult"}}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/accounts/_query":{"post":{"tags":["Accounts"],"summary":"Queries the Accounts","description":"Queries the Accounts with the given AccountQuery parameter returning all matching Accounts","operationId":"accountQuery","consumes":["application/xml","application/json"],"produces":["application/xml","application/json"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId in which to search results.","required":true,"type":"string","default":"_"},{"in":"body","name":"body","description":"The AccountQuery to use to filter results.","required":true,"schema":{"$ref":"#/definitions/AccountQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AccountListResult"}}},"security":[{"kapuaAccessToken":[]}]}},"/authentication/refresh":{"post":{"tags":["Authentication"],"summary":"Refreshes an AccessToken","description":"Both the current AccessToken and the Refresh token will be invalidated. If also the Refresh token is expired, the user will have to restart with a new login.","operationId":"authenticationRefresh","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"in":"body","name":"body","description":"The current AccessToken's tokenId and refreshToken","required":true,"schema":{"$ref":"#/definitions/RefreshTokenCredentials"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AccessToken"}}}}},"/authentication/logout":{"post":{"tags":["Authentication"],"summary":"Logs out an user","description":"Terminates the current session and invalidates the access token","operationId":"authenticationLogout","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[],"responses":{"default":{"description":"successful operation"}}}},"/authentication/user":{"post":{"tags":["Authentication"],"summary":"Authenticate an user","description":"Authenticates an user with username and password and returns the authentication token to be used in subsequent REST API calls.","operationId":"authenticationUser","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"in":"body","name":"body","description":"The username and password authentication credential of a user.","required":true,"schema":{"$ref":"#/definitions/UsernamePasswordCredentials"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AccessToken"}}}}},"/authentication/apikey":{"post":{"tags":["Authentication"],"summary":"Authenticate an user","description":"Authenticates an user with API KEY and returns the authentication token to be used in subsequent REST API calls.","operationId":"authenticationApiKey","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"in":"body","name":"body","description":"The API KEY authentication credential of a user.","required":true,"schema":{"$ref":"#/definitions/ApiKeyCredentials"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AccessToken"}}}}},"/authentication/jwt":{"post":{"tags":["Authentication"],"summary":"Authenticate an user","description":"Authenticates an user with a JWT and returns the authentication token to be used in subsequent REST API calls.","operationId":"authenticationJwt","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"in":"body","name":"body","description":"The JWT authentication credential of a user.","required":true,"schema":{"$ref":"#/definitions/JwtCredentials"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AccessToken"}}}}},"/{scopeId}/credentials":{"get":{"tags":["Credentials"],"summary":"Gets the Credential list in the scope","description":"Returns the list of all the credentials associated to the current selected scope.","operationId":"credentialSimpleQuery","produces":["application/json","application/xml"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId in which to search results.","required":true,"type":"string","default":"_"},{"name":"userId","in":"query","description":"The optional id to filter results.","required":false,"type":"string"},{"name":"offset","in":"query","description":"The result set offset.","required":false,"type":"integer","default":0,"format":"int32"},{"name":"limit","in":"query","description":"The result set limit.","required":true,"type":"integer","default":50,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CredentialListResult"}}},"security":[{"kapuaAccessToken":[]}]},"post":{"tags":["Credentials"],"summary":"Create a Credential","description":"Creates a new Credential based on the information provided in CredentialCreator parameter.","operationId":"credentialCreate","consumes":["application/xml","application/json"],"produces":["application/xml","application/json"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId in which to create the Credential","required":true,"type":"string","default":"_"},{"in":"body","name":"body","description":"Provides the information for the new Credential to be created","required":true,"schema":{"$ref":"#/definitions/CredentialCreator"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Credential"}}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/credentials/{credentialId}":{"get":{"tags":["Credentials"],"summary":"Get a Credential","description":"Returns the Credential specified by the \"credentialId\" path parameter.","operationId":"credentialFind","produces":["application/json","application/xml"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId of the requested Credential.","required":true,"type":"string","default":"_"},{"name":"credentialId","in":"path","description":"The id of the requested Credential","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Credential"}}},"security":[{"kapuaAccessToken":[]}]},"put":{"tags":["Credentials"],"summary":"Update an Credential","description":"Updates a new Credential based on the information provided in the Credential parameter.","operationId":"credentialUpdate","consumes":["application/xml","application/json"],"produces":["application/xml","application/json"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId of the requested Credential.","required":true,"type":"string","default":"_"},{"name":"credentialId","in":"path","description":"The id of the requested Credential","required":true,"type":"string"},{"in":"body","name":"body","description":"The modified Credential whose attributed need to be updated","required":true,"schema":{"$ref":"#/definitions/Credential"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Credential"}}},"security":[{"kapuaAccessToken":[]}]},"delete":{"tags":["Credentials"],"summary":"Delete a Credential","description":"Deletes the Credential specified by the \"credentialId\" path parameter.","operationId":"credentialDelete","parameters":[{"name":"scopeId","in":"path","description":"The ScopeId of the Credential to delete.","required":true,"type":"string","default":"_"},{"name":"credentialId","in":"path","description":"The id of the Credential to be deleted","required":true,"type":"string"}],"responses":{"default":{"description":"successful operation"}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/credentials/{credentialId}/unlock":{"post":{"tags":["Credentials"],"summary":"Unlock a Credential","description":"Unlocks a Credential that has been locked due to a lockout policy.","operationId":"credentialUnlock","parameters":[{"name":"scopeId","in":"path","description":"The ScopeId of the Credential to delete.","required":true,"type":"string","default":"_"},{"name":"credentialId","in":"path","description":"The id of the Credential to be unlocked","required":true,"type":"string"}],"responses":{"default":{"description":"successful operation"}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/credentials/_count":{"post":{"tags":["Credentials"],"summary":"Counts the Credentials","description":"Counts the Credentials with the given CredentialQuery parameter returning the number of matching Credentials","operationId":"credentialCount","consumes":["application/xml","application/json"],"produces":["application/xml","application/json"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId in which to count results","required":true,"type":"string","default":"_"},{"in":"body","name":"body","description":"The CredentialQuery to use to filter count results","required":true,"schema":{"$ref":"#/definitions/CredentialQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CountResult"}}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/credentials/_query":{"post":{"tags":["Credentials"],"summary":"Queries the Credentials","description":"Queries the Credentials with the given CredentialQuery parameter returning all matching Credentials","operationId":"credentialQuery","consumes":["application/xml","application/json"],"produces":["application/xml","application/json"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId in which to search results.","required":true,"type":"string","default":"_"},{"in":"body","name":"body","description":"The CredentialQuery to use to filter results.","required":true,"schema":{"$ref":"#/definitions/CredentialQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CredentialListResult"}}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/data/channels":{"get":{"tags":["Data Channels"],"summary":"Gets the ChannelInfo list in the scope","description":"Returns the list of all the channelInfos associated to the current selected scope.","operationId":"dataChannelSimpleQuery","produces":["application/json","application/xml"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId in which to search results","required":true,"type":"string","default":"_"},{"name":"clientId","in":"query","description":"The client id to filter results","required":false,"type":"string"},{"name":"name","in":"query","description":"The channel name to filter results. It allows '#' wildcard in last channel level","required":false,"type":"string"},{"name":"offset","in":"query","description":"The result set offset","required":false,"type":"integer","default":0,"format":"int32"},{"name":"limit","in":"query","description":"The result set limit","required":false,"type":"integer","default":50,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChannelInfoListResult"}}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/data/channels/_count":{"post":{"tags":["Data Channels"],"summary":"Counts the ChannelInfos","description":"Counts the ChannelInfos with the given ChannelInfoQuery parameter returning the number of matching ChannelInfos","operationId":"dataChannelCount","consumes":["application/xml","application/json"],"produces":["application/xml","application/json"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId in which to search results","required":true,"type":"string","default":"_"},{"in":"body","name":"body","description":"The ChannelInfoQuery to use to filter count results","required":true,"schema":{"$ref":"#/definitions/ChannelInfoQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CountResult"}}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/data/channels/{channelInfoId}":{"get":{"tags":["Data Channels"],"summary":"Gets an ChannelInfo","description":"Gets the ChannelInfo specified by the channelInfoId path parameter","operationId":"dataChannelFind","produces":["application/json","application/xml"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId of the requested ChannelInfo.","required":true,"type":"string","default":"_"},{"name":"channelInfoId","in":"path","description":"The id of the requested ChannelInfo","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChannelInfo"}}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/data/channels/_query":{"post":{"tags":["Data Channels"],"summary":"Queries the ChannelInfos","description":"Queries the ChannelInfos with the given ChannelInfoQuery parameter returning all matching ChannelInfos","operationId":"dataChannelQuery","consumes":["application/xml","application/json"],"produces":["application/xml","application/json"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId in which to search results","required":true,"type":"string","default":"_"},{"in":"body","name":"body","description":"The ChannelInfoQuery to use to filter results","required":true,"schema":{"$ref":"#/definitions/ChannelInfoQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChannelInfoListResult"}}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/data/clients":{"get":{"tags":["Data Clients"],"summary":"Gets the ClientInfo list in the scope","description":"Returns the list of all the clientInfos associated to the current selected scope.","operationId":"dataClientSimpleQuery","produces":["application/json","application/xml"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId in which to search results","required":true,"type":"string","default":"_"},{"name":"clientId","in":"query","description":"The client id to filter results","required":false,"type":"string"},{"name":"offset","in":"query","description":"The result set offset","required":false,"type":"integer","default":0,"format":"int32"},{"name":"limit","in":"query","description":"The result set limit","required":false,"type":"integer","default":50,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ClientInfoListResult"}}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/data/clients/_count":{"post":{"tags":["Data Clients"],"summary":"Counts the ClientInfos","description":"Counts the ClientInfos with the given ClientInfoQuery parameter returning the number of matching ClientInfos","operationId":"dataClientCount","consumes":["application/xml","application/json"],"produces":["application/xml","application/json"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId in which to search results","required":true,"type":"string","default":"_"},{"in":"body","name":"body","description":"The ClientInfoQuery to use to filter count results","required":true,"schema":{"$ref":"#/definitions/ClientInfoQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CountResult"}}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/data/clients/{clientInfoId}":{"get":{"tags":["Data Clients"],"summary":"Gets an ClientInfo","description":"Gets the ClientInfo specified by the clientInfoId path parameter","operationId":"dataClientFind","produces":["application/json","application/xml"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId of the requested ClientInfo.","required":true,"type":"string","default":"_"},{"name":"clientInfoId","in":"path","description":"The id of the requested ClientInfo","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ClientInfo"}}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/data/clients/_query":{"post":{"tags":["Data Clients"],"summary":"Queries the ClientInfos","description":"Queries the ClientInfos with the given ClientInfoQuery parameter returning all matching ClientInfos","operationId":"dataClientQuery","consumes":["application/xml","application/json"],"produces":["application/xml","application/json"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId in which to search results","required":true,"type":"string","default":"_"},{"in":"body","name":"body","description":"The ClientInfoQuery to use to filter results","required":true,"schema":{"$ref":"#/definitions/ClientInfoQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ClientInfoListResult"}}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/data/messages":{"get":{"tags":["Data Messages"],"summary":"Gets the DatastoreMessage list in the scope","description":"Returns the list of all the datastoreMessages associated to the current selected scope.","operationId":"dataMessageSimpleQuery","produces":["application/json"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId in which to search results","required":true,"type":"string","default":"_"},{"name":"clientId","in":"query","description":"The client id to filter results","required":false,"type":"string"},{"name":"channel","in":"query","description":"The channel to filter results.","required":false,"type":"string"},{"name":"strictChannel","in":"query","description":"Restrict the search only to this channel ignoring its children. Only meaningful if channel is set.","required":false,"type":"boolean"},{"name":"startDate","in":"query","description":"The start date to filter the results. Must come before endDate parameter","required":false,"type":"string"},{"name":"endDate","in":"query","description":"The end date to filter the results. Must come after startDate parameter","required":false,"type":"string"},{"name":"metricName","in":"query","description":"The metric name to filter results","required":false,"type":"string"},{"name":"metricType","in":"query","description":"The metric type to filter results","required":false,"type":"string"},{"name":"metricMin","in":"query","description":"The min metric value to filter results","required":false,"type":"string"},{"name":"metricMax","in":"query","description":"The max metric value to filter results","required":false,"type":"string"},{"name":"offset","in":"query","description":"The result set offset","required":false,"type":"integer","default":0,"format":"int32"},{"name":"limit","in":"query","description":"The result set limit","required":false,"type":"integer","default":50,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessageListResult"}}},"security":[{"kapuaAccessToken":[]}]},"post":{"tags":["Data Messages"],"summary":"Stores a new KapuaDataMessage","description":"Stores a new KapuaDataMessage under the account of the currently connected user. In this case, the provided message will only be stored in the back-end database and it will not be forwarded to the message broker.","operationId":"dataMessageStore","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId in which to store the message","required":true,"type":"string","default":"_"},{"in":"body","name":"body","description":"The KapuaDataMessage to be stored","required":false,"schema":{"$ref":"#/definitions/JsonKapuaDataMessage"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/StorableId"}}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/data/messages/_count":{"post":{"tags":["Data Messages"],"summary":"Counts the DatastoreMessages","description":"Counts the DatastoreMessages with the given DatastoreMessageQuery parameter returning the number of matching DatastoreMessages","operationId":"dataMessageCount","consumes":["application/xml","application/json"],"produces":["application/xml","application/json"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId in which to search results","required":true,"type":"string","default":"_"},{"in":"body","name":"body","description":"The DatastoreMessageQuery to use to filter count results","required":true,"schema":{"$ref":"#/definitions/MessageQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CountResult"}}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/data/messages/{datastoreMessageId}":{"get":{"tags":["Data Messages"],"summary":"Gets an DatastoreMessage","description":"Gets the DatastoreMessage specified by the datastoreMessageId path parameter","operationId":"dataMessageFind","produces":["application/json"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId of the requested DatastoreMessage.","required":true,"type":"string","default":"_"},{"name":"datastoreMessageId","in":"path","description":"The id of the requested DatastoreMessage","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DatastoreMessage"}}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/data/messages/_query":{"post":{"tags":["Data Messages"],"summary":"Queries the DatastoreMessages","description":"Queries the DatastoreMessages with the given DatastoreMessageQuery parameter returning all matching DatastoreMessages","operationId":"dataMessageQuery","consumes":["application/xml","application/json"],"produces":["application/json"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId in which to search results","required":true,"type":"string","default":"_"},{"in":"body","name":"body","description":"The DatastoreMessageQuery to use to filter results","required":true,"schema":{"$ref":"#/definitions/MessageQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessageListResult"}}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/data/metrics":{"get":{"tags":["Data Metrics"],"summary":"Gets the MetricInfo list in the scope","description":"Returns the list of all the metricInfos associated to the current selected scope.","operationId":"dataMetricSimpleQuery","produces":["application/json","application/xml"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId in which to search results","required":true,"type":"string","default":"_"},{"name":"clientId","in":"query","description":"The client id to filter results","required":false,"type":"string"},{"name":"channel","in":"query","description":"The channel to filter results. It allows '#' wildcard in last channel level","required":false,"type":"string"},{"name":"name","in":"query","description":"The metric name to filter results","required":false,"type":"string"},{"name":"offset","in":"query","description":"The result set offset","required":false,"type":"integer","default":0,"format":"int32"},{"name":"limit","in":"query","description":"The result set limit","required":false,"type":"integer","default":50,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MetricInfoListResult"}}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/data/metrics/_count":{"post":{"tags":["Data Metrics"],"summary":"Counts the MetricInfos","description":"Counts the MetricInfos with the given MetricInfoQuery parameter returning the number of matching MetricInfos","operationId":"dataMetricCount","consumes":["application/xml","application/json"],"produces":["application/xml","application/json"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId in which to search results","required":true,"type":"string","default":"_"},{"in":"body","name":"body","description":"The MetricInfoQuery to use to filter count results","required":true,"schema":{"$ref":"#/definitions/MetricInfoQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CountResult"}}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/data/metrics/{metricInfoId}":{"get":{"tags":["Data Metrics"],"summary":"Gets an MetricInfo","description":"Gets the MetricInfo specified by the metricInfoId path parameter","operationId":"dataMetricFind","produces":["application/json","application/xml"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId of the requested MetricInfo.","required":true,"type":"string","default":"_"},{"name":"metricInfoId","in":"path","description":"The id of the requested MetricInfo","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MetricInfo"}}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/data/metrics/_query":{"post":{"tags":["Data Metrics"],"summary":"Queries the MetricInfos","description":"Queries the MetricInfos with the given MetricInfoQuery parameter returning all matching MetricInfos","operationId":"dataMetricQuery","consumes":["application/xml","application/json"],"produces":["application/xml","application/json"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId in which to search results","required":true,"type":"string","default":"_"},{"in":"body","name":"body","description":"The MetricInfoQuery to use to filter results","required":true,"schema":{"$ref":"#/definitions/MetricInfoQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MetricInfoListResult"}}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/deviceconnections/{connectionId}/options":{"get":{"tags":["Device Connections"],"summary":"Gets the DeviceConnection list in the scope","description":"Returns the list of all the deviceConnections associated to the current selected scope.","operationId":"find","produces":["application/json","application/xml"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId in which to search results.","required":true,"type":"string","default":"_"},{"name":"connectionId","in":"path","description":"The connection id of the requested options.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DeviceConnection"}}}},"put":{"tags":["Device Connections"],"summary":"Get an DeviceConnectionOption","description":"Returns the DeviceConnectionOption specified by the given parameters","operationId":"update","produces":["application/json","application/xml"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId of the requested DeviceConnectionOptions.","required":true,"type":"string","default":"_"},{"name":"connectionId","in":"path","description":"The id of the requested DeviceConnectionOptions","required":true,"type":"string"},{"in":"body","name":"body","description":"The modified Device connection options whose attributed need to be updated","required":true,"schema":{"$ref":"#/definitions/DeviceConnectionOption"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DeviceConnectionOption"}}}}},"/{scopeId}/deviceconnections":{"get":{"tags":["Device Connections"],"summary":"Gets the DeviceConnection list in the scope","description":"Returns the list of all the deviceConnections associated to the current selected scope.","operationId":"deviceConnectionSimpleQuery","produces":["application/json","application/xml"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId in which to search results.","required":true,"type":"string","default":"_"},{"in":"body","name":"body","description":"The client id to filter results.","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","description":"The connection status to filter results.","required":false,"type":"string","enum":["CONNECTED","DISCONNECTED","MISSING","NULL"]},{"name":"offset","in":"query","description":"The result set offset.","required":false,"type":"integer","default":0,"format":"int32"},{"name":"limit","in":"query","description":"The result set limit.","required":false,"type":"integer","default":50,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DeviceConnectionListResult"}}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/deviceconnections/_count":{"post":{"tags":["Device Connections"],"summary":"Counts the DeviceConnections","description":"Counts the DeviceConnections with the given DeviceConnectionQuery parameter returning the number of matching DeviceConnections","operationId":"deviceConnectionCount","consumes":["application/xml","application/json"],"produces":["application/xml","application/json"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId in which to count results","required":true,"type":"string","default":"_"},{"in":"body","name":"body","description":"The DeviceConnectionQuery to use to filter count results","required":true,"schema":{"$ref":"#/definitions/DeviceConnectionQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CountResult"}}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/deviceconnections/{deviceConnectionId}":{"get":{"tags":["Device Connections"],"summary":"Get an DeviceConnection","description":"Returns the DeviceConnection specified by the \"deviceConnectionId\" path parameter.","operationId":"deviceConnectionFind","produces":["application/json","application/xml"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId of the requested DeviceConnection.","required":true,"type":"string","default":"_"},{"name":"deviceConnectionId","in":"path","description":"The id of the requested DeviceConnection","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DeviceConnection"}}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/deviceconnections/_query":{"post":{"tags":["Device Connections"],"summary":"Queries the DeviceConnections","description":"Queries the DeviceConnections with the given DeviceConnections parameter returning all matching DeviceConnections","operationId":"deviceConnectionQuery","consumes":["application/xml","application/json"],"produces":["application/xml","application/json"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId in which to search results.","required":true,"type":"string","default":"_"},{"in":"body","name":"body","description":"The DeviceConnectionQuery to use to filter results.","required":true,"schema":{"$ref":"#/definitions/DeviceConnectionQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DeviceConnectionListResult"}}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/devices/{deviceId}/events":{"get":{"tags":["Devices"],"summary":"Gets the DeviceEvent list in the scope","description":"Returns the list of all the deviceEvents associated to the current selected scope.","operationId":"deviceEventSimpleQuery","produces":["application/json","application/xml"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId in which to search results.","required":true,"type":"string","default":"_"},{"name":"deviceId","in":"path","description":"The client id to filter results.","required":true,"type":"string"},{"name":"resource","in":"query","description":"The resource of the DeviceEvent in which to search results","required":false,"type":"string"},{"name":"offset","in":"query","description":"The result set offset.","required":false,"type":"integer","default":0,"format":"int32"},{"name":"limit","in":"query","description":"The result set limit.","required":false,"type":"integer","default":50,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DeviceEventListResult"}}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/devices/{deviceId}/events/{deviceEventId}":{"get":{"tags":["Devices"],"summary":"Get an DeviceEvent","description":"Returns the DeviceEvent specified by the \"deviceEventId\" path parameter.","operationId":"deviceEventFind","produces":["application/json","application/xml"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId of the requested DeviceEvent.","required":true,"type":"string","default":"_"},{"name":"deviceId","in":"path","description":"The id of the requested Device","required":true,"type":"string"},{"name":"deviceEventId","in":"path","description":"The id of the requested DeviceEvent","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DeviceEvent"}}},"security":[{"kapuaAccessToken":[]}]},"delete":{"tags":["Devices"],"summary":"Delete a DeviceEvent","description":"Deletes the DeviceEvent specified by the \"deviceEventId\" path parameter.","operationId":"deviceEventDelete","parameters":[{"name":"scopeId","in":"path","required":true,"type":"string"},{"name":"deviceId","in":"path","description":"The id of the Device in which to delete the event.","required":true,"type":"string"},{"name":"deviceEventId","in":"path","description":"The id of the DeviceEvent to be deleted","required":true,"type":"string"}],"responses":{"default":{"description":"successful operation"}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/devices/{deviceId}/events/_count":{"post":{"tags":["Devices"],"summary":"Counts the DeviceEvents","description":"Counts the DeviceEvents with the given DeviceEventQuery parameter returning the number of matching DeviceEvents","operationId":"deviceEventCount","consumes":["application/xml","application/json"],"produces":["application/xml","application/json"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId in which to count results.","required":true,"type":"string","default":"_"},{"name":"deviceId","in":"path","description":"The id of the Device in which to count results","required":true,"type":"string"},{"in":"body","name":"body","description":"The DeviceEventQuery to use to filter count results","required":true,"schema":{"$ref":"#/definitions/DeviceEventQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CountResult"}}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/devices/{deviceId}/events/_query":{"post":{"tags":["Devices"],"summary":"Queries the DeviceEvents","description":"Queries the DeviceEvents with the given DeviceEvents parameter returning all matching DeviceEvents","operationId":"deviceEventQuery","consumes":["application/xml","application/json"],"produces":["application/xml","application/json"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId in which to search results.","required":true,"type":"string","default":"_"},{"name":"deviceId","in":"path","description":"The id of the Device in which to search results","required":true,"type":"string"},{"in":"body","name":"body","description":"The DeviceEventQuery to use to filter results.","required":true,"schema":{"$ref":"#/definitions/DeviceEventQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DeviceEventListResult"}}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/devices/{deviceId}/assets":{"get":{"tags":["Devices"],"summary":"Gets a list of assets","description":"Returns the list of all the Assets installed on the device.","operationId":"deviceAssetGet","produces":["application/json","application/xml"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId of the device.","required":true,"type":"string","default":"_"},{"name":"deviceId","in":"path","description":"The id of the device","required":true,"type":"string"},{"name":"timeout","in":"query","description":"The timeout of the operation in milliseconds","required":false,"type":"integer","format":"int64"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DeviceAssets"}}},"security":[{"kapuaAccessToken":[]}]},"post":{"tags":["Devices"],"summary":"Gets a list of assets","description":"Returns the list of all the Assets installed on the device.","operationId":"deviceAssetFilteredGet","produces":["application/json","application/xml"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId of the device.","required":true,"type":"string","default":"_"},{"name":"deviceId","in":"path","description":"The id of the device","required":true,"type":"string"},{"name":"timeout","in":"query","description":"The timeout of the operation in milliseconds","required":false,"type":"integer","format":"int64"},{"in":"body","name":"body","description":"The filter of the request","required":false,"schema":{"$ref":"#/definitions/DeviceAssets"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DeviceAssets"}}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/devices/{deviceId}/assets/_write":{"post":{"tags":["Devices"],"summary":"Gets a list of assets","description":"Returns the list of all the Assets installed on the device.","operationId":"deviceAssetWrite","produces":["application/json","application/xml"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId of the device.","required":true,"type":"string","default":"_"},{"name":"deviceId","in":"path","description":"The id of the device","required":true,"type":"string"},{"name":"timeout","in":"query","description":"The timeout of the operation in milliseconds","required":false,"type":"integer","format":"int64"},{"in":"body","name":"body","description":"The values to write to the asset channels","required":false,"schema":{"$ref":"#/definitions/DeviceAssets"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DeviceAssets"}}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/devices/{deviceId}/assets/_read":{"post":{"tags":["Devices"],"summary":"Reads asset channel values","description":"Returns the value read from the asset channel","operationId":"deviceAssetRead","produces":["application/json","application/xml"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId of the device.","required":true,"type":"string","default":"_"},{"name":"deviceId","in":"path","description":"The id of the device","required":true,"type":"string"},{"name":"timeout","in":"query","description":"The timeout of the operation in milliseconds","required":false,"type":"integer","format":"int64"},{"in":"body","name":"body","description":"The filter of the read request","required":false,"schema":{"$ref":"#/definitions/DeviceAssets"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DeviceAssets"}}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/devices/{deviceId}/bundles":{"get":{"tags":["Devices"],"summary":"Gets a list of bundles","description":"Returns the list of all the Bundles installed on the device.","operationId":"deviceBundleGet","produces":["application/json","application/xml"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId of the device.","required":true,"type":"string","default":"_"},{"name":"deviceId","in":"path","description":"The id of the device","required":true,"type":"string"},{"name":"timeout","in":"query","description":"The timeout of the operation in milliseconds","required":false,"type":"integer","format":"int64"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DeviceBundles"}}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/devices/{deviceId}/bundles/{bundleId}/_start":{"post":{"tags":["Devices"],"summary":"Start a bundle","description":"Starts the specified bundle","operationId":"deviceBundleStart","produces":["application/xml","application/json"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId of the device.","required":true,"type":"string","default":"_"},{"name":"deviceId","in":"path","description":"The id of the device","required":true,"type":"string"},{"name":"bundleId","in":"path","description":"the ID of the bundle to start","required":true,"type":"string"},{"name":"timeout","in":"query","description":"The timeout of the operation in milliseconds","required":false,"type":"integer","format":"int64"}],"responses":{"default":{"description":"successful operation"}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/devices/{deviceId}/bundles/{bundleId}/_stop":{"post":{"tags":["Devices"],"summary":"Stop a bundle","description":"Stops the specified bundle","operationId":"deviceBundleStop","produces":["application/xml","application/json"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId of the device.","required":true,"type":"string","default":"_"},{"name":"deviceId","in":"path","description":"The id of the device","required":true,"type":"string"},{"name":"bundleId","in":"path","description":"the ID of the bundle to stop","required":true,"type":"string"},{"name":"timeout","in":"query","description":"The timeout of the operation in milliseconds","required":false,"type":"integer","format":"int64"}],"responses":{"default":{"description":"successful operation"}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/devices/{deviceId}/commands/_execute":{"post":{"tags":["Devices"],"summary":"Executes a command","description":"Executes a remote command on a device and return the command output.","operationId":"deviceCommandExecute","consumes":["application/xml","application/json"],"produces":["application/xml","application/json"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId of the device","required":true,"type":"string","default":"_"},{"name":"deviceId","in":"path","description":"The id of the device","required":true,"type":"string"},{"name":"timeout","in":"query","description":"The timeout of the command execution","required":false,"type":"integer","format":"int64"},{"in":"body","name":"body","description":"The input command","required":true,"schema":{"$ref":"#/definitions/DeviceCommandInput"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DeviceCommandOutput"}}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/devices/{deviceId}/configurations/{componentId}":{"get":{"tags":["Devices"],"summary":"Gets the device configurations","description":"Returns the configuration of a device or the configuration of the OSGi component identified with specified PID (service's persistent identity). In the OSGi framework, the service's persistent identity is defined as the name attribute of the Component Descriptor XML file; at runtime, the same value is also available in the component.name and in the service.pid attributes of the Component Configuration.","operationId":"deviceConfigurationComponentGet","produces":["application/json","application/xml"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId of the Device.","required":true,"type":"string","default":"_"},{"name":"deviceId","in":"path","description":"The id of the device","required":true,"type":"string"},{"name":"componentId","in":"path","description":"An optional id of the component to get the configuration for","required":true,"type":"string"},{"name":"timeout","in":"query","description":"The timeout of the operation in milliseconds","required":false,"type":"integer","format":"int64"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DeviceConfiguration"}}},"security":[{"kapuaAccessToken":[]}]},"put":{"tags":["Devices"],"summary":"Updates a device component configuration","description":"Updates a device component configuration","operationId":"deviceConfigurationComponentUpdate","consumes":["application/json","application/xml"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId of the Device.","required":true,"type":"string","default":"_"},{"name":"deviceId","in":"path","description":"The id of the device","required":true,"type":"string"},{"name":"componentId","in":"path","description":"The component id to update","required":true,"type":"string"},{"name":"timeout","in":"query","description":"The timeout of the operation in milliseconds","required":false,"type":"integer","format":"int64"},{"in":"body","name":"body","description":"The component configuration to send to the device","required":true,"schema":{"$ref":"#/definitions/DeviceComponentConfiguration"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DeviceConfiguration"}}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/devices/{deviceId}/configurations":{"get":{"tags":["Devices"],"summary":"Gets the device configurations","description":"Returns the current configuration of a device","operationId":"deviceConfigurationGet","produces":["application/json","application/xml"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId of the Device.","required":true,"type":"string","default":"_"},{"name":"deviceId","in":"path","description":"The id of the device","required":true,"type":"string"},{"name":"timeout","in":"query","description":"The timeout of the operation in milliseconds","required":false,"type":"integer","format":"int64"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DeviceConfiguration"}}},"security":[{"kapuaAccessToken":[]}]},"put":{"tags":["Devices"],"summary":"Updates a device component configuration","description":"Updates a device component configuration","operationId":"deviceConfigurationUpdate","consumes":["application/json","application/xml"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId of the Device.","required":true,"type":"string","default":"_"},{"name":"deviceId","in":"path","description":"The id of the device","required":true,"type":"string"},{"name":"timeout","in":"query","description":"The timeout of the operation in milliseconds","required":false,"type":"integer","format":"int64"},{"in":"body","name":"body","description":"The configuration to send to the device","required":true,"schema":{"$ref":"#/definitions/DeviceConfiguration"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DeviceConfiguration"}}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/devices/{deviceId}/packages/_download":{"post":{"tags":["Devices"],"summary":"Installs a package","description":"Installs a package into the device.","operationId":"devicePackageDownload","produces":["application/xml","application/json"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId of the Device","required":true,"type":"string","default":"_"},{"name":"deviceId","in":"path","description":"The id of the device","required":true,"type":"string"},{"name":"timeout","in":"query","description":"The timeout of the operation","required":false,"type":"integer","format":"int64"},{"in":"body","name":"body","description":"Mandatory object with all the informations needed to download and install a package","required":true,"schema":{"$ref":"#/definitions/DevicePackageDownloadRequest"}}],"responses":{"default":{"description":"successful operation"}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/devices/{deviceId}/packages/_uninstall":{"post":{"tags":["Devices"],"summary":"Uninstalls a package","description":"Uninstalls a package into the device.","operationId":"devicePackageUninstall","produces":["application/xml","application/json"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId of the Device","required":true,"type":"string","default":"_"},{"name":"deviceId","in":"path","description":"The id of the device","required":true,"type":"string"},{"name":"timeout","in":"query","description":"The timeout of the operation","required":false,"type":"integer","format":"int64"},{"in":"body","name":"body","description":"Mandatory object with all the informations needed to uninstall a package","required":true,"schema":{"$ref":"#/definitions/DevicePackageUninstallRequest"}}],"responses":{"default":{"description":"successful operation"}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/devices/{deviceId}/packages":{"get":{"tags":["Devices"],"summary":"Gets a list of packages","description":"Returns the list of all the packages installed on the device.","operationId":"devicePackageGet","produces":["application/json","application/xml"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId of the Device","required":true,"type":"string","default":"_"},{"name":"deviceId","in":"path","description":"The id of the device","required":true,"type":"string"},{"name":"timeout","in":"query","description":"The timeout of the operation","required":false,"type":"integer","format":"int64"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DeviceSnapshots"}}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/devices/{deviceId}/requests":{"post":{"tags":["Devices"],"summary":"Sends a request","description":"Sends a request message to a device","operationId":"deviceRequestSend","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId of the device","required":true,"type":"string","default":"_"},{"name":"deviceId","in":"path","description":"The id of the device","required":true,"type":"string"},{"name":"timeout","in":"query","description":"The timeout of the request execution","required":false,"type":"integer","format":"int64"},{"in":"body","name":"body","description":"The input request","required":true,"schema":{"$ref":"#/definitions/JsonGenericRequestMessage"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DeviceCommandOutput"}}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/devices/{deviceId}/snapshots/{snapshotId}/_rollback":{"post":{"tags":["Devices"],"summary":"Gets a list of snapshots","description":"Updates the configuration of a device rolling back a given snapshot ID.","operationId":"deviceSnapshotRollback","produces":["application/xml","application/json"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId of the device","required":true,"type":"string","default":"_"},{"name":"deviceId","in":"path","description":"The id of the device","required":true,"type":"string"},{"name":"snapshotId","in":"path","description":"the ID of the snapshot to rollback to","required":true,"type":"string"},{"name":"timeout","in":"query","description":"The timeout of the operation","required":false,"type":"integer","format":"int64"}],"responses":{"default":{"description":"successful operation"}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/devices/{deviceId}/snapshots":{"get":{"tags":["Devices"],"summary":"Gets a list of snapshots","description":"Returns the list of all the Snapshots available on the device.","operationId":"deviceSnapshotGet","produces":["application/json","application/xml"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId of the device","required":true,"type":"string","default":"_"},{"name":"deviceId","in":"path","description":"The id of the device","required":true,"type":"string"},{"name":"timeout","in":"query","description":"The timeout of the operation","required":false,"type":"integer","format":"int64"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DeviceSnapshots"}}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/devices":{"get":{"tags":["Devices"],"summary":"Gets the Device list in the scope","description":"Returns the list of all the devices associated to the current selected scope.","operationId":"deviceSimpleQuery","produces":["application/json","application/xml"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId in which to search results.","required":true,"type":"string","default":"_"},{"name":"tagId","in":"query","description":"The tag id to filter results.","required":false,"type":"string"},{"name":"clientId","in":"query","description":"The client id to filter results.","required":false,"type":"string"},{"name":"status","in":"query","description":"The connection status to filter results.","required":false,"type":"string","enum":["CONNECTED","DISCONNECTED","MISSING","NULL"]},{"name":"fetchAttributes","in":"query","description":"Additional attributes to be returned. Allowed values: connection, lastEvent","required":false,"type":"array","items":{"type":"string","enum":["connection","lastEvent"]},"collectionFormat":"multi"},{"name":"offset","in":"query","description":"The result set offset.","required":false,"type":"integer","default":0,"format":"int32"},{"name":"limit","in":"query","description":"The result set limit.","required":false,"type":"integer","default":50,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DeviceListResult"}}},"security":[{"kapuaAccessToken":[]}]},"post":{"tags":["Devices"],"summary":"Create an Device","description":"Creates a new Device based on the information provided in DeviceCreator parameter.","operationId":"deviceCreate","consumes":["application/xml","application/json"],"produces":["application/xml","application/json"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId in which to create the Device.","required":true,"type":"string","default":"_"},{"in":"body","name":"body","description":"Provides the information for the new Device to be created","required":true,"schema":{"$ref":"#/definitions/DeviceCreator"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Device"}}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/devices/{deviceId}":{"get":{"tags":["Devices"],"summary":"Get a Device","description":"Returns the Device specified by the \"deviceId\" path parameter.","operationId":"deviceFind","produces":["application/json","application/xml"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId of the requested Device","required":true,"type":"string","default":"_"},{"name":"deviceId","in":"path","description":"The id of the requested Device","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Device"}}},"security":[{"kapuaAccessToken":[]}]},"put":{"tags":["Devices"],"summary":"Update a Device","description":"Updates a new Device based on the information provided in the Device parameter.","operationId":"deviceUpdate","consumes":["application/xml","application/json"],"produces":["application/xml","application/json"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId of the requested Device.","required":true,"type":"string","default":"_"},{"name":"deviceId","in":"path","description":"The id of the requested Device","required":true,"type":"string"},{"in":"body","name":"body","description":"The modified Device whose attributed need to be updated","required":true,"schema":{"$ref":"#/definitions/Device"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Device"}}},"security":[{"kapuaAccessToken":[]}]},"delete":{"tags":["Devices"],"summary":"Delete a Device","description":"Deletes the Device specified by the \"deviceId\" path parameter.","operationId":"deviceDelete","parameters":[{"name":"scopeId","in":"path","description":"The ScopeId of the Device to delete.","required":true,"type":"string","default":"_"},{"name":"deviceId","in":"path","description":"The id of the Device to be deleted","required":true,"type":"string"}],"responses":{"default":{"description":"successful operation"}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/devices/_count":{"post":{"tags":["Devices"],"summary":"Counts the Devices","description":"Counts the Devices with the given DeviceQuery parameter returning the number of matching Devices","operationId":"deviceCount","consumes":["application/xml","application/json"],"produces":["application/xml","application/json"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId in which to count results","required":true,"type":"string","default":"_"},{"in":"body","name":"body","description":"The DeviceQuery to use to filter count results","required":true,"schema":{"$ref":"#/definitions/DeviceQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CountResult"}}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/devices/_query":{"post":{"tags":["Devices"],"summary":"Queries the Devices","description":"Queries the Devices with the given Devices parameter returning all matching Devices","operationId":"deviceQuery","consumes":["application/xml","application/json"],"produces":["application/xml","application/json"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId in which to search results.","required":true,"type":"string","default":"_"},{"in":"body","name":"body","description":"The DeviceQuery to use to filter results.","required":true,"schema":{"$ref":"#/definitions/DeviceQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DeviceListResult"}}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/domains":{"get":{"tags":["Domains"],"summary":"Gets the Domain list in the scope","description":"Returns the list of all the domains associated to the current selected scope.","operationId":"domainSimpleQuery","produces":["application/json","application/xml"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId in which to search results.","required":true,"type":"string","default":"_"},{"name":"name","in":"query","description":"The domain name to filter results.","required":false,"type":"string"},{"name":"offset","in":"query","description":"The result set offset.","required":false,"type":"integer","default":0,"format":"int32"},{"name":"limit","in":"query","description":"The result set limit.","required":false,"type":"integer","default":50,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainListResult"}}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/domains/_count":{"post":{"tags":["Domains"],"summary":"Counts the Domains","description":"Counts the Domains with the given DomainQuery parameter returning the number of matching Domains","operationId":"domainCount","consumes":["application/xml","application/json"],"produces":["application/xml","application/json"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId in which to count results","required":true,"type":"string","default":"_"},{"in":"body","name":"body","description":"The DomainQuery to use to filter count results","required":true,"schema":{"$ref":"#/definitions/DomainQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CountResult"}}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/domains/{domainId}":{"get":{"tags":["Domains"],"summary":"Get a Domain","description":"Returns the Domain specified by the \"domainId\" path parameter.","operationId":"domainFind","produces":["application/json","application/xml"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId of the requested Domain.","required":true,"type":"string","default":"_"},{"name":"domainId","in":"path","description":"The id of the requested Domain","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Domain"}}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/domains/_query":{"post":{"tags":["Domains"],"summary":"Queries the Domains","description":"Queries the Domains with the given DomainQuery parameter returning all matching Domains","operationId":"domainQuery","consumes":["application/xml","application/json"],"produces":["application/xml","application/json"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId in which to search results.","required":true,"type":"string","default":"_"},{"in":"body","name":"body","description":"The DomainQuery to use to filter results.","required":true,"schema":{"$ref":"#/definitions/DomainQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainListResult"}}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/endpointInfos":{"get":{"tags":["EndpointInfos"],"summary":"Gets the EndpointInfo list in the scope","description":"Returns the list of all the endpointInfos associated to the current selected scope.","operationId":"endpointInfoSimpleQuery","produces":["application/json","application/xml"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId in which to search results.","required":true,"type":"string","default":"_"},{"name":"usage","in":"query","description":"The endpointInfo usage to filter results.","required":false,"type":"string"},{"name":"offset","in":"query","description":"The result set offset.","required":false,"type":"integer","default":0,"format":"int32"},{"name":"limit","in":"query","description":"The result set limit.","required":false,"type":"integer","default":50,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EndpointInfoListResult"}}},"security":[{"kapuaAccessToken":[]}]},"post":{"tags":["EndpointInfos"],"summary":"Create a EndpointInfo","description":"Creates a new EndpointInfo based on the information provided in EndpointInfoCreator parameter.","operationId":"createEndpointInfo","consumes":["application/xml","application/json"],"produces":["application/xml","application/json"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId in which to create the EndpointInfo","required":true,"type":"string","default":"_"},{"in":"body","name":"body","description":"Provides the information for the new EndpointInfo to be created","required":true,"schema":{"$ref":"#/definitions/EndpointInfoCreator"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EndpointInfo"}}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/endpointInfos/{endpointInfoId}":{"get":{"tags":["EndpointInfos"],"summary":"Get a EndpointInfo","description":"Returns the EndpointInfo specified by the \"endpointInfoId\" path parameter.","operationId":"endpointInfoFind","produces":["application/json","application/xml"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId of the requested EndpointInfo.","required":true,"type":"string","default":"_"},{"name":"endpointInfoId","in":"path","description":"The id of the requested EndpointInfo","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EndpointInfo"}}},"security":[{"kapuaAccessToken":[]}]},"put":{"tags":["EndpointInfos"],"summary":"Update a EndpointInfo","description":"Updates a new EndpointInfo based on the information provided in the EndpointInfo parameter.","operationId":"endpointInfoUpdate","consumes":["application/xml","application/json"],"produces":["application/xml","application/json"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId of the requested EndpointInfo.","required":true,"type":"string","default":"_"},{"name":"endpointInfoId","in":"path","description":"The id of the requested EndpointInfo","required":true,"type":"string"},{"in":"body","name":"body","description":"The modified EndpointInfo whose attributed need to be updated","required":true,"schema":{"$ref":"#/definitions/EndpointInfo"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EndpointInfo"}}},"security":[{"kapuaAccessToken":[]}]},"delete":{"tags":["EndpointInfos"],"summary":"Delete an EndpointInfo","description":"Deletes the EndpointInfo specified by the \"endpointInfoId\" path parameter.","operationId":"endpointInfoDelete","parameters":[{"name":"scopeId","in":"path","description":"The ScopeId of the EndpointInfo to delete.","required":true,"type":"string","default":"_"},{"name":"endpointInfoId","in":"path","description":"The id of the EndpointInfo to be deleted","required":true,"type":"string"}],"responses":{"default":{"description":"successful operation"}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/endpointInfos/_count":{"post":{"tags":["EndpointInfos"],"summary":"Counts the EndpointInfos","description":"Counts the EndpointInfos with the given EndpointInfoQuery parameter returning the number of matching EndpointInfos","operationId":"endpointInfoCount","consumes":["application/xml","application/json"],"produces":["application/xml","application/json"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId in which to count results","required":true,"type":"string","default":"_"},{"in":"body","name":"body","description":"The EndpointInfoQuery to use to filter count results","required":true,"schema":{"$ref":"#/definitions/EndpointInfoQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CountResult"}}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/endpointInfos/_query":{"post":{"tags":["EndpointInfos"],"summary":"Queries the EndpointInfos","description":"Queries the EndpointInfos with the given EndpointInfoQuery parameter returning all matching EndpointInfos","operationId":"endpointInfoQuery","consumes":["application/xml","application/json"],"produces":["application/xml","application/json"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId in which to search results.","required":true,"type":"string","default":"_"},{"in":"body","name":"body","description":"The EndpointInfoQuery to use to filter results.","required":true,"schema":{"$ref":"#/definitions/EndpointInfoQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EndpointInfoListResult"}}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/groups":{"get":{"tags":["Groups"],"summary":"Gets the Group list in the scope","description":"Returns the list of all the groups associated to the current selected scope.","operationId":"groupSimpleQuery","produces":["application/json","application/xml"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId in which to search results.","required":true,"type":"string","default":"_"},{"name":"name","in":"query","description":"The group name to filter results.","required":false,"type":"string"},{"name":"offset","in":"query","description":"The result set offset.","required":false,"type":"integer","default":0,"format":"int32"},{"name":"limit","in":"query","description":"The result set limit.","required":false,"type":"integer","default":50,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GroupListResult"}}},"security":[{"kapuaAccessToken":[]}]},"post":{"tags":["Groups"],"summary":"Create a Group","description":"Creates a new Group based on the information provided in GroupCreator parameter.","operationId":"groupCreate","consumes":["application/xml","application/json"],"produces":["application/xml","application/json"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId in which to create the Group","required":true,"type":"string","default":"_"},{"in":"body","name":"body","description":"Provides the information for the new Group to be created","required":true,"schema":{"$ref":"#/definitions/GroupCreator"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Group"}}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/groups/{groupId}":{"get":{"tags":["Groups"],"summary":"Get an Group","description":"Returns the Group specified by the \"groupId\" path parameter.","operationId":"groupFind","produces":["application/json","application/xml"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId of the requested Group.","required":true,"type":"string","default":"_"},{"name":"groupId","in":"path","description":"The id of the requested Group","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Group"}}},"security":[{"kapuaAccessToken":[]}]},"put":{"tags":["Groups"],"summary":"Update an Group","description":"Updates a new Group based on the information provided in the Group parameter.","operationId":"groupUpdate","consumes":["application/xml","application/json"],"produces":["application/xml","application/json"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId of the requested Group.","required":true,"type":"string","default":"_"},{"name":"groupId","in":"path","description":"The id of the requested Group","required":true,"type":"string"},{"in":"body","name":"body","description":"The modified Group whose attributed need to be updated","required":true,"schema":{"$ref":"#/definitions/Group"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Group"}}},"security":[{"kapuaAccessToken":[]}]},"delete":{"tags":["Groups"],"summary":"Delete an Group","description":"Deletes the Group specified by the \"groupId\" path parameter.","operationId":"groupDelete","parameters":[{"name":"scopeId","in":"path","description":"The ScopeId of the Group to delete.","required":true,"type":"string","default":"_"},{"name":"groupId","in":"path","description":"The id of the Group to be deleted","required":true,"type":"string"}],"responses":{"default":{"description":"successful operation"}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/groups/_count":{"post":{"tags":["Groups"],"summary":"Counts the Groups","description":"Counts the Groups with the given GroupQuery parameter returning the number of matching Groups","operationId":"groupCount","consumes":["application/xml","application/json"],"produces":["application/xml","application/json"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId in which to count results","required":true,"type":"string","default":"_"},{"in":"body","name":"body","description":"The GroupQuery to use to filter count results","required":true,"schema":{"$ref":"#/definitions/GroupQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CountResult"}}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/groups/_query":{"post":{"tags":["Groups"],"summary":"Queries the Groups","description":"Queries the Groups with the given GroupQuery parameter returning all matching Groups","operationId":"groupQuery","consumes":["application/xml","application/json"],"produces":["application/xml","application/json"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId in which to search results.","required":true,"type":"string","default":"_"},{"in":"body","name":"body","description":"The GroupQuery to use to filter results.","required":true,"schema":{"$ref":"#/definitions/GroupQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GroupListResult"}}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/roles":{"get":{"tags":["Roles"],"summary":"Gets the Role list in the scope","description":"Returns the list of all the roles associated to the current selected scope.","operationId":"roleSimpleQuery","produces":["application/json","application/xml"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId in which to search results.","required":true,"type":"string","default":"_"},{"name":"name","in":"query","description":"The role name to filter results.","required":false,"type":"string"},{"name":"offset","in":"query","description":"The result set offset.","required":false,"type":"integer","default":0,"format":"int32"},{"name":"limit","in":"query","description":"The result set limit.","required":false,"type":"integer","default":50,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RoleListResult"}}},"security":[{"kapuaAccessToken":[]}]},"post":{"tags":["Roles"],"summary":"Create a Role","description":"Creates a new Role based on the information provided in RoleCreator parameter.","operationId":"roleCreate","consumes":["application/xml","application/json"],"produces":["application/xml","application/json"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId in which to create the Account","required":true,"type":"string","default":"_"},{"in":"body","name":"body","description":"Provides the information for the new Role to be created","required":true,"schema":{"$ref":"#/definitions/RoleCreator"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Role"}}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/roles/{roleId}":{"get":{"tags":["Roles"],"summary":"Get a Role","description":"Returns the Role specified by the \"roleId\" path parameter.","operationId":"roleFind","produces":["application/json","application/xml"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId of the requested Account.","required":true,"type":"string","default":"_"},{"name":"roleId","in":"path","description":"The id of the requested Role","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Role"}}},"security":[{"kapuaAccessToken":[]}]},"put":{"tags":["Roles"],"summary":"Update an Role","description":"Updates a new Role based on the information provided in the Role parameter.","operationId":"roleUpdate","consumes":["application/xml","application/json"],"produces":["application/xml","application/json"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId of the requested Account.","required":true,"type":"string","default":"_"},{"name":"roleId","in":"path","description":"The id of the requested Role","required":true,"type":"string"},{"in":"body","name":"body","description":"The modified Role whose attributed need to be updated","required":true,"schema":{"$ref":"#/definitions/Role"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Role"}}},"security":[{"kapuaAccessToken":[]}]},"delete":{"tags":["Roles"],"summary":"Delete a Role","description":"Deletes the Role specified by the \"roleId\" path parameter.","operationId":"roleDelete","parameters":[{"name":"scopeId","in":"path","description":"The ScopeId of the Account to delete.","required":true,"type":"string","default":"_"},{"name":"roleId","in":"path","description":"The id of the Role to be deleted","required":true,"type":"string"}],"responses":{"default":{"description":"successful operation"}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/roles/_count":{"post":{"tags":["Roles"],"summary":"Counts the Roles","description":"Counts the Roles with the given RoleQuery parameter returning the number of matching Roles","operationId":"roleCount","consumes":["application/xml","application/json"],"produces":["application/xml","application/json"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId in which to count results","required":true,"type":"string","default":"_"},{"in":"body","name":"body","description":"The RoleQuery to use to filter count results","required":true,"schema":{"$ref":"#/definitions/RoleQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CountResult"}}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/roles/_query":{"post":{"tags":["Roles"],"summary":"Queries the Roles","description":"Queries the Roles with the given RoleQuery parameter returning all matching Roles","operationId":"roleQuery","consumes":["application/xml","application/json"],"produces":["application/xml","application/json"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId in which to search results.","required":true,"type":"string","default":"_"},{"in":"body","name":"body","description":"The RoleQuery to use to filter results.","required":true,"schema":{"$ref":"#/definitions/RoleQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RoleListResult"}}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/roles/{roleId}/permissions/{rolePermissionId}":{"get":{"tags":["Roles"],"summary":"Get a RolePermission","description":"Returns the RolePermission specified by the \"rolePermissionId\" path parameter.","operationId":"rolePermissionFind","produces":["application/json","application/xml"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId of the requested RolePermission.","required":true,"type":"string","default":"_"},{"name":"roleId","in":"path","description":"Specifies the RoleId for the requested RolePermission","required":true,"type":"string"},{"name":"rolePermissionId","in":"path","description":"The id of the requested RolePermission","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RolePermission"}}},"security":[{"kapuaAccessToken":[]}]},"delete":{"tags":["Roles"],"summary":"Delete an RolePermission","description":"Deletes the RolePermission specified by the \"rolePermissionId\" path parameter.","operationId":"rolePermissionDelete","parameters":[{"name":"scopeId","in":"path","description":"The ScopeId of the RolePermission to delete.","required":true,"type":"string","default":"_"},{"name":"roleId","in":"path","description":"Specifies the Role Id for the requested RolePermission","required":true,"type":"string"},{"name":"rolePermissionId","in":"path","description":"The id of the RolePermission to be deleted","required":true,"type":"string"}],"responses":{"default":{"description":"successful operation"}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/roles/{roleId}/permissions":{"get":{"tags":["Roles"],"summary":"Gets the RolePermission list in the scope","description":"Returns the list of all the rolePermissions associated to the current selected scope.","operationId":"rolePermissionSimpleQuery","produces":["application/json","application/xml"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId in which to search results.","required":true,"type":"string","default":"_"},{"name":"roleId","in":"path","description":"The id of the Role to filter results.","required":true,"type":"string"},{"name":"name","in":"query","description":"The domain name to filter results.","required":false,"type":"string"},{"name":"action","in":"query","description":"The action to filter results.","required":false,"type":"string","enum":["read","write","delete","connect","execute"]},{"name":"offset","in":"query","description":"The result set offset.","required":false,"type":"integer","default":0,"format":"int32"},{"name":"limit","in":"query","description":"The result set limit.","required":false,"type":"integer","default":50,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RolePermissionListResult"}}},"security":[{"kapuaAccessToken":[]}]},"post":{"tags":["Roles"],"summary":"Create a RolePermission","description":"Creates a new RolePermission based on the information provided in RolePermissionCreator parameter.","operationId":"rolePermissionCreate","consumes":["application/xml","application/json"],"produces":["application/xml","application/json"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId in which to create the RolePermission","required":true,"type":"string","default":"_"},{"name":"roleId","in":"path","description":"The Role id in which to create the RolePermission.","required":true,"type":"string"},{"in":"body","name":"body","description":"Provides the information for the new RolePermission to be created","required":true,"schema":{"$ref":"#/definitions/RolePermissionCreator"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RolePermission"}}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/roles/{roleId}/permissions/_count":{"post":{"tags":["Roles"],"summary":"Counts the RolePermissions","description":"Counts the RolePermissions with the given RolePermissionQuery parameter returning the number of matching RolePermissions","operationId":"rolePermissionCount","consumes":["application/xml","application/json"],"produces":["application/xml","application/json"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId in which to count results.","required":true,"type":"string","default":"_"},{"name":"roleId","in":"path","description":"The Role id in which to count results.","required":true,"type":"string"},{"in":"body","name":"body","description":"The RolePermissionQuery to use to filter results.","required":true,"schema":{"$ref":"#/definitions/RolePermissionQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CountResult"}}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/roles/{roleId}/permissions/_query":{"post":{"tags":["Roles"],"summary":"Queries the RolePermissions","description":"Queries the RolePermissions with the given RolePermissionQuery parameter returning all matching RolePermissions","operationId":"rolePermissionQuery","consumes":["application/xml","application/json"],"produces":["application/xml","application/json"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId in which to search results.","required":true,"type":"string","default":"_"},{"name":"roleId","in":"path","description":"The Role id in which to search results.","required":true,"type":"string"},{"in":"body","name":"body","description":"The RolePermissionQuery to use to filter results.","required":true,"schema":{"$ref":"#/definitions/RolePermissionQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RolePermissionListResult"}}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/streams/messages":{"post":{"tags":["Streams"],"summary":"Publishes a fire-and-forget message","description":"Publishes a fire-and-forget message to a topic composed of [account-name] / [client-id] / [semtantic-parts]","operationId":"streamPublish","consumes":["application/json"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId of the device","required":true,"type":"string","default":"_"},{"name":"timeout","in":"query","description":"The timeout of the request execution","required":false,"type":"integer","format":"int64"},{"in":"body","name":"body","description":"The input request","required":true,"schema":{"$ref":"#/definitions/JsonKapuaDataMessage"}}],"responses":{"default":{"description":"successful operation"}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/tags/{tagId}":{"get":{"tags":["Tags"],"summary":"Get a Tag","description":"Returns the Tag specified by the \"tagId\" path parameter.","operationId":"tagFind","produces":["application/json","application/xml"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId of the requested Tag.","required":true,"type":"string","default":"_"},{"name":"tagId","in":"path","description":"The id of the requested Tag","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Tag"}}},"security":[{"kapuaAccessToken":[]}]},"put":{"tags":["Tags"],"summary":"Update a Tag","description":"Updates a new Tag based on the information provided in the Tag parameter.","operationId":"tagUpdate","consumes":["application/xml","application/json"],"produces":["application/xml","application/json"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId of the requested Tag.","required":true,"type":"string","default":"_"},{"name":"tagId","in":"path","description":"The id of the requested Tag","required":true,"type":"string"},{"in":"body","name":"body","description":"The modified Tag whose attributed need to be updated","required":true,"schema":{"$ref":"#/definitions/Tag"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Tag"}}},"security":[{"kapuaAccessToken":[]}]},"delete":{"tags":["Tags"],"summary":"Delete an Tag","description":"Deletes the Tag specified by the \"tagId\" path parameter.","operationId":"tagDelete","parameters":[{"name":"scopeId","in":"path","description":"The ScopeId of the Tag to delete.","required":true,"type":"string","default":"_"},{"name":"tagId","in":"path","description":"The id of the Tag to be deleted","required":true,"type":"string"}],"responses":{"default":{"description":"successful operation"}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/tags":{"get":{"tags":["Tags"],"summary":"Gets the Tag list in the scope","description":"Returns the list of all the tags associated to the current selected scope.","operationId":"tagSimpleQuery","produces":["application/json","application/xml"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId in which to search results.","required":true,"type":"string","default":"_"},{"name":"name","in":"query","description":"The tag name to filter results.","required":false,"type":"string"},{"name":"offset","in":"query","description":"The result set offset.","required":false,"type":"integer","default":0,"format":"int32"},{"name":"limit","in":"query","description":"The result set limit.","required":false,"type":"integer","default":50,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TagListResult"}}},"security":[{"kapuaAccessToken":[]}]},"post":{"tags":["Tags"],"summary":"Create a Tag","description":"Creates a new Tag based on the information provided in TagCreator parameter.","operationId":"createTag","consumes":["application/xml","application/json"],"produces":["application/xml","application/json"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId in which to create the Tag","required":true,"type":"string","default":"_"},{"in":"body","name":"body","description":"Provides the information for the new Tag to be created","required":true,"schema":{"$ref":"#/definitions/TagCreator"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Tag"}}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/tags/_count":{"post":{"tags":["Tags"],"summary":"Counts the Tags","description":"Counts the Tags with the given TagQuery parameter returning the number of matching Tags","operationId":"tagCount","consumes":["application/xml","application/json"],"produces":["application/xml","application/json"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId in which to count results","required":true,"type":"string","default":"_"},{"in":"body","name":"body","description":"The TagQuery to use to filter count results","required":true,"schema":{"$ref":"#/definitions/TagQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CountResult"}}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/tags/_query":{"post":{"tags":["Tags"],"summary":"Queries the Tags","description":"Queries the Tags with the given TagQuery parameter returning all matching Tags","operationId":"tagQuery","consumes":["application/xml","application/json"],"produces":["application/xml","application/json"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId in which to search results.","required":true,"type":"string","default":"_"},{"in":"body","name":"body","description":"The TagQuery to use to filter results.","required":true,"schema":{"$ref":"#/definitions/TagQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TagListResult"}}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/users/{userId}":{"get":{"tags":["Users"],"summary":"Get an User","description":"Returns the User specified by the \"userId\" path parameter.","operationId":"userFind","produces":["application/json","application/xml"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId of the requested User.","required":true,"type":"string","default":"_"},{"name":"userId","in":"path","description":"The id of the requested User","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/User"}}},"security":[{"kapuaAccessToken":[]}]},"put":{"tags":["Users"],"summary":"Update an User","description":"Updates a new User based on the information provided in the User parameter.","operationId":"userUpdate","consumes":["application/xml","application/json"],"produces":["application/xml","application/json"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId of the requested User.","required":true,"type":"string","default":"_"},{"name":"userId","in":"path","description":"The id of the requested User","required":true,"type":"string"},{"in":"body","name":"body","description":"The modified User whose attributes needs to be updated","required":true,"schema":{"$ref":"#/definitions/User"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/User"}}},"security":[{"kapuaAccessToken":[]}]},"delete":{"tags":["Users"],"summary":"Delete an User","description":"Deletes the User specified by the \"userId\" path parameter.","operationId":"userDelete","parameters":[{"name":"scopeId","in":"path","description":"The ScopeId of the User to delete.","required":true,"type":"string","default":"_"},{"name":"userId","in":"path","description":"The id of the User to be deleted","required":true,"type":"string"}],"responses":{"default":{"description":"successful operation"}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/users":{"get":{"tags":["Users"],"summary":"Gets the User list in the scope","description":"Returns the list of all the users associated to the current selected scope.","operationId":"userSimpleQuery","produces":["application/json","application/xml"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId in which to search results.","required":true,"type":"string","default":"_"},{"name":"name","in":"query","description":"The user name to filter results.","required":false,"type":"string"},{"name":"offset","in":"query","description":"The result set offset.","required":false,"type":"integer","default":0,"format":"int32"},{"name":"limit","in":"query","description":"The result set limit.","required":false,"type":"integer","default":50,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserListResult"}}},"security":[{"kapuaAccessToken":[]}]},"post":{"tags":["Users"],"summary":"Create an User","description":"Creates a new User based on the information provided in UserCreator parameter.","operationId":"userCreate","consumes":["application/xml","application/json"],"produces":["application/xml","application/json"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId in which to create the User","required":true,"type":"string","default":"_"},{"in":"body","name":"body","description":"Provides the information for the new User to be created","required":true,"schema":{"$ref":"#/definitions/UserCreator"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/User"}}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/users/_count":{"post":{"tags":["Users"],"summary":"Counts the Users","description":"Counts the Users with the given UserQuery parameter returning the number of matching Users","operationId":"userCount","consumes":["application/xml","application/json"],"produces":["application/xml","application/json"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId in which to count results","required":true,"type":"string","default":"_"},{"in":"body","name":"body","description":"The UserQuery to use to filter count results","required":true,"schema":{"$ref":"#/definitions/UserQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CountResult"}}},"security":[{"kapuaAccessToken":[]}]}},"/{scopeId}/users/_query":{"post":{"tags":["Users"],"summary":"Queries the Users","description":"Queries the Users with the given UserQuery parameter returning all matching Users","operationId":"userQuery","consumes":["application/xml","application/json"],"produces":["application/xml","application/json"],"parameters":[{"name":"scopeId","in":"path","description":"The ScopeId in which to search results.","required":true,"type":"string","default":"_"},{"in":"body","name":"body","description":"The UserQuery to use to filter results.","required":true,"schema":{"$ref":"#/definitions/UserQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserListResult"}}},"security":[{"kapuaAccessToken":[]}]}}},"securityDefinitions":{"kapuaAccessToken":{"description":"","type":"apiKey","name":"Authorization","in":"header"}},"definitions":{"AccessInfo":{"type":"object","properties":{"userId":{"type":"string"},"type":{"type":"string"},"modifiedOn":{"type":"string","format":"date-time"},"modifiedBy":{"type":"string"},"optlock":{"type":"integer","format":"int32"},"entityAttributes":{"type":"object","additionalProperties":{"type":"string"}},"entityProperties":{"type":"object","additionalProperties":{"type":"string"}},"scopeId":{"type":"string"},"id":{"type":"string"},"createdBy":{"type":"string"},"createdOn":{"type":"string","format":"date-time"}}},"AccessInfoListResult":{"type":"object","properties":{"items":{"type":"array","xml":{"wrapped":true},"items":{"xml":{"name":"item"},"$ref":"#/definitions/AccessInfo"}},"limitExceeded":{"type":"boolean"},"firstItem":{"$ref":"#/definitions/AccessInfo"},"empty":{"type":"boolean"},"size":{"type":"integer","format":"int32"}},"xml":{"name":"accessInfos"}},"CountResult":{"type":"object","properties":{"count":{"type":"integer","format":"int64"}},"xml":{"name":"countResult"}},"AccessInfoQuery":{"type":"object","properties":{"limit":{"type":"integer","format":"int32"},"scopeId":{"type":"string"},"fetchAttributes":{"type":"array","xml":{"name":"fetchAttributeName","wrapped":true},"items":{"type":"string","xml":{"name":"fetchAttributeName"}}},"predicate":{"$ref":"#/definitions/QueryPredicate"},"sortCriteria":{"$ref":"#/definitions/KapuaSortCriteria"},"offset":{"type":"integer","format":"int32"}},"xml":{"name":"query"}},"KapuaSortCriteria":{"type":"object"},"QueryPredicate":{"type":"object"},"AccessInfoCreator":{"type":"object","properties":{"permissions":{"type":"array","xml":{"wrapped":true},"uniqueItems":true,"items":{"xml":{"name":"permission"},"$ref":"#/definitions/Permission"}},"userId":{"type":"string"},"roleIds":{"type":"string","xml":{"wrapped":true}},"scopeId":{"type":"string"}}},"Permission":{"type":"object","properties":{"domain":{"type":"string"},"action":{"type":"string","enum":["read","write","delete","connect","execute"]},"groupId":{"type":"string"},"targetScopeId":{"type":"string"},"forwardable":{"type":"boolean"}},"xml":{"name":"permission"}},"AccessPermission":{"type":"object","properties":{"accessInfoId":{"type":"string"},"type":{"type":"string"},"permission":{"$ref":"#/definitions/Permission"},"scopeId":{"type":"string"},"id":{"type":"string"},"createdBy":{"type":"string"},"createdOn":{"type":"string","format":"date-time"}},"xml":{"name":"accessPermission"}},"AccessPermissionListResult":{"type":"object","properties":{"items":{"type":"array","xml":{"wrapped":true},"items":{"xml":{"name":"item"},"$ref":"#/definitions/AccessPermission"}},"limitExceeded":{"type":"boolean"},"firstItem":{"$ref":"#/definitions/AccessPermission"},"empty":{"type":"boolean"},"size":{"type":"integer","format":"int32"}},"xml":{"name":"accessPermissions"}},"AccessPermissionQuery":{"type":"object","properties":{"limit":{"type":"integer","format":"int32"},"scopeId":{"type":"string"},"fetchAttributes":{"type":"array","xml":{"name":"fetchAttributeName","wrapped":true},"items":{"type":"string","xml":{"name":"fetchAttributeName"}}},"predicate":{"$ref":"#/definitions/QueryPredicate"},"sortCriteria":{"$ref":"#/definitions/KapuaSortCriteria"},"offset":{"type":"integer","format":"int32"}},"xml":{"name":"query"}},"AccessPermissionCreator":{"type":"object","properties":{"accessInfoId":{"type":"string"},"permission":{"$ref":"#/definitions/Permission"},"scopeId":{"type":"string"}},"xml":{"name":"accessPermissionCreator"}},"AccessRole":{"type":"object","properties":{"roleId":{"type":"string"},"accessInfoId":{"type":"string"},"type":{"type":"string"},"scopeId":{"type":"string"},"id":{"type":"string"},"createdBy":{"type":"string"},"createdOn":{"type":"string","format":"date-time"}},"xml":{"name":"accessRole"}},"AccessRoleListResult":{"type":"object","properties":{"items":{"type":"array","xml":{"wrapped":true},"items":{"xml":{"name":"item"},"$ref":"#/definitions/AccessRole"}},"limitExceeded":{"type":"boolean"},"firstItem":{"$ref":"#/definitions/AccessRole"},"empty":{"type":"boolean"},"size":{"type":"integer","format":"int32"}},"xml":{"name":"accessPermissions"}},"AccessRoleQuery":{"type":"object","properties":{"limit":{"type":"integer","format":"int32"},"scopeId":{"type":"string"},"fetchAttributes":{"type":"array","xml":{"name":"fetchAttributeName","wrapped":true},"items":{"type":"string","xml":{"name":"fetchAttributeName"}}},"predicate":{"$ref":"#/definitions/QueryPredicate"},"sortCriteria":{"$ref":"#/definitions/KapuaSortCriteria"},"offset":{"type":"integer","format":"int32"}},"xml":{"name":"query"}},"AccessRoleCreator":{"type":"object","properties":{"roleId":{"type":"string"},"accessInfoId":{"type":"string"},"scopeId":{"type":"string"}},"xml":{"name":"accessRoleCreator"}},"Account":{"type":"object","properties":{"organization":{"$ref":"#/definitions/Organization"},"expirationDate":{"type":"string","format":"date-time"},"childAccounts":{"type":"array","items":{"$ref":"#/definitions/Account"}},"parentAccountPath":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"},"modifiedOn":{"type":"string","format":"date-time"},"modifiedBy":{"type":"string"},"optlock":{"type":"integer","format":"int32"},"entityAttributes":{"type":"object","additionalProperties":{"type":"string"}},"entityProperties":{"type":"object","additionalProperties":{"type":"string"}},"scopeId":{"type":"string"},"id":{"type":"string"},"createdBy":{"type":"string"},"createdOn":{"type":"string","format":"date-time"}},"xml":{"name":"account"}},"AccountListResult":{"type":"object","properties":{"items":{"type":"array","xml":{"wrapped":true},"items":{"xml":{"name":"item"},"$ref":"#/definitions/Account"}},"limitExceeded":{"type":"boolean"},"firstItem":{"$ref":"#/definitions/Account"},"empty":{"type":"boolean"},"size":{"type":"integer","format":"int32"}},"xml":{"name":"accountListResult"}},"Organization":{"type":"object","properties":{"country":{"type":"string"},"personName":{"type":"string"},"stateProvinceCounty":{"type":"string"},"email":{"type":"string"},"phoneNumber":{"type":"string"},"addressLine1":{"type":"string"},"addressLine2":{"type":"string"},"zipPostCode":{"type":"string"},"city":{"type":"string"},"name":{"type":"string"}}},"AccountQuery":{"type":"object","properties":{"limit":{"type":"integer","format":"int32"},"scopeId":{"type":"string"},"fetchAttributes":{"type":"array","xml":{"name":"fetchAttributeName","wrapped":true},"items":{"type":"string","xml":{"name":"fetchAttributeName"}}},"predicate":{"$ref":"#/definitions/QueryPredicate"},"sortCriteria":{"$ref":"#/definitions/KapuaSortCriteria"},"offset":{"type":"integer","format":"int32"}},"xml":{"name":"query"}},"AccountCreator":{"type":"object","properties":{"expirationDate":{"type":"string","format":"date-time"},"organizationName":{"type":"string"},"organizationPersonName":{"type":"string"},"organizationEmail":{"type":"string"},"organizationPhoneNumber":{"type":"string"},"organizationAddressLine1":{"type":"string"},"organizationAddressLine2":{"type":"string"},"organizationCity":{"type":"string"},"organizationZipPostCode":{"type":"string"},"organizationStateProvinceCounty":{"type":"string"},"organizationCountry":{"type":"string"},"name":{"type":"string"},"entityAttributes":{"type":"object","additionalProperties":{"type":"string"}},"scopeId":{"type":"string"}},"xml":{"name":"accountCreator"}},"AccessToken":{"type":"object","properties":{"userId":{"type":"string"},"expiresOn":{"type":"string","format":"date-time"},"refreshToken":{"type":"string"},"tokenId":{"type":"string"},"refreshExpiresOn":{"type":"string","format":"date-time"},"invalidatedOn":{"type":"string","format":"date-time"},"type":{"type":"string"},"modifiedOn":{"type":"string","format":"date-time"},"modifiedBy":{"type":"string"},"optlock":{"type":"integer","format":"int32"},"entityAttributes":{"type":"object","additionalProperties":{"type":"string"}},"entityProperties":{"type":"object","additionalProperties":{"type":"string"}},"scopeId":{"type":"string"},"id":{"type":"string"},"createdBy":{"type":"string"},"createdOn":{"type":"string","format":"date-time"}}},"RefreshTokenCredentials":{"type":"object","properties":{"refreshToken":{"type":"string"},"tokenId":{"type":"string"}},"xml":{"name":"refreshTokenCredentials"}},"UsernamePasswordCredentials":{"type":"object","properties":{"password":{"type":"string"},"username":{"type":"string"}},"xml":{"name":"usernamePasswordCredentials"}},"ApiKeyCredentials":{"type":"object","properties":{"apiKey":{"type":"string"}},"xml":{"name":"apiKeyCredentials"}},"JwtCredentials":{"type":"object","properties":{"jwt":{"type":"string"}},"xml":{"name":"jwtCredentials"}},"Credential":{"type":"object","properties":{"status":{"type":"string","enum":["ENABLED","DISABLED"]},"lockoutReset":{"type":"string","format":"date-time"},"firstLoginFailure":{"type":"string","format":"date-time"},"loginFailuresReset":{"type":"string","format":"date-time"},"loginFailures":{"type":"integer","format":"int32"},"credentialType":{"type":"string","enum":["PASSWORD","API_KEY","JWT"]},"expirationDate":{"type":"string","format":"date-time"},"userId":{"type":"string"},"credentialKey":{"type":"string"},"type":{"type":"string"},"modifiedOn":{"type":"string","format":"date-time"},"modifiedBy":{"type":"string"},"optlock":{"type":"integer","format":"int32"},"entityAttributes":{"type":"object","additionalProperties":{"type":"string"}},"entityProperties":{"type":"object","additionalProperties":{"type":"string"}},"scopeId":{"type":"string"},"id":{"type":"string"},"createdBy":{"type":"string"},"createdOn":{"type":"string","format":"date-time"}},"xml":{"name":"credential"}},"CredentialListResult":{"type":"object","properties":{"items":{"type":"array","xml":{"wrapped":true},"items":{"xml":{"name":"item"},"$ref":"#/definitions/Credential"}},"limitExceeded":{"type":"boolean"},"firstItem":{"$ref":"#/definitions/Credential"},"empty":{"type":"boolean"},"size":{"type":"integer","format":"int32"}},"xml":{"name":"credentialListResult"}},"CredentialQuery":{"type":"object","properties":{"limit":{"type":"integer","format":"int32"},"scopeId":{"type":"string"},"fetchAttributes":{"type":"array","xml":{"name":"fetchAttributeName","wrapped":true},"items":{"type":"string","xml":{"name":"fetchAttributeName"}}},"predicate":{"$ref":"#/definitions/QueryPredicate"},"sortCriteria":{"$ref":"#/definitions/KapuaSortCriteria"},"offset":{"type":"integer","format":"int32"}},"xml":{"name":"query"}},"CredentialCreator":{"type":"object","properties":{"credentialType":{"type":"string","enum":["PASSWORD","API_KEY","JWT"]},"expirationDate":{"type":"string","format":"date-time"},"userId":{"type":"string"},"credentialPlainKey":{"type":"string","xml":{"name":"credentialKey"}},"credentialStatus":{"type":"string","enum":["ENABLED","DISABLED"]},"scopeId":{"type":"string"}},"xml":{"name":"credentialCreator"}},"ChannelInfo":{"type":"object","properties":{"scopeId":{"type":"string"},"id":{"$ref":"#/definitions/StorableId"},"clientId":{"type":"string"},"lastMessageOn":{"type":"string","format":"date-time"},"firstMessageId":{"$ref":"#/definitions/StorableId"},"firstMessageOn":{"type":"string","format":"date-time"},"lastMessageId":{"$ref":"#/definitions/StorableId"},"name":{"type":"string"}},"xml":{"name":"channel"}},"ChannelInfoListResult":{"type":"object","properties":{"items":{"type":"array","xml":{"wrapped":true},"items":{"xml":{"name":"item"},"$ref":"#/definitions/ChannelInfo"}},"limitExceeded":{"type":"boolean"},"firstItem":{"$ref":"#/definitions/ChannelInfo"},"nextKey":{"type":"object"},"totalCount":{"type":"integer","format":"int64"},"empty":{"type":"boolean"},"size":{"type":"integer","format":"int32"}},"xml":{"name":"channelInfos"}},"StorableId":{"type":"object"},"ChannelInfoQuery":{"type":"object","properties":{"limit":{"type":"integer","format":"int32"},"scopeId":{"$ref":"#/definitions/KapuaId"},"fetchAttributes":{"type":"array","xml":{"name":"fetchAttributeName","wrapped":true},"items":{"type":"string","xml":{"name":"fetchAttributeName"}}},"predicate":{"$ref":"#/definitions/StorablePredicate"},"askTotalCount":{"type":"boolean"},"fetchStyle":{"type":"string","enum":["FIELDS","SOURCE_SELECT","SOURCE_FULL"]},"sortFields":{"type":"array","items":{"$ref":"#/definitions/SortField"}},"offset":{"type":"integer","format":"int32"}},"xml":{"name":"query"}},"KapuaId":{"type":"object","properties":{"id":{"type":"integer"}}},"SortField":{"type":"object","properties":{"sortDirection":{"type":"string","enum":["ASC","DESC"]},"field":{"type":"string"}}},"StorablePredicate":{"type":"object"},"ClientInfo":{"type":"object","properties":{"scopeId":{"type":"string"},"id":{"$ref":"#/definitions/StorableId"},"clientId":{"type":"string"},"lastMessageOn":{"type":"string","format":"date-time"},"firstMessageId":{"$ref":"#/definitions/StorableId"},"firstMessageOn":{"type":"string","format":"date-time"},"lastMessageId":{"$ref":"#/definitions/StorableId"}},"xml":{"name":"clientInfo"}},"ClientInfoListResult":{"type":"object","properties":{"items":{"type":"array","xml":{"wrapped":true},"items":{"xml":{"name":"item"},"$ref":"#/definitions/ClientInfo"}},"limitExceeded":{"type":"boolean"},"firstItem":{"$ref":"#/definitions/ClientInfo"},"nextKey":{"type":"object"},"totalCount":{"type":"integer","format":"int64"},"empty":{"type":"boolean"},"size":{"type":"integer","format":"int32"}},"xml":{"name":"clientInfos"}},"ClientInfoQuery":{"type":"object","properties":{"limit":{"type":"integer","format":"int32"},"scopeId":{"$ref":"#/definitions/KapuaId"},"fetchAttributes":{"type":"array","xml":{"name":"fetchAttributeName","wrapped":true},"items":{"type":"string","xml":{"name":"fetchAttributeName"}}},"predicate":{"$ref":"#/definitions/StorablePredicate"},"askTotalCount":{"type":"boolean"},"fetchStyle":{"type":"string","enum":["FIELDS","SOURCE_SELECT","SOURCE_FULL"]},"sortFields":{"type":"array","items":{"$ref":"#/definitions/SortField"}},"offset":{"type":"integer","format":"int32"}},"xml":{"name":"query"}},"DatastoreMessage":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time"},"position":{"$ref":"#/definitions/KapuaPosition"},"payload":{"$ref":"#/definitions/KapuaPayload"},"scopeId":{"type":"string"},"id":{"type":"string","format":"uuid"},"capturedOn":{"type":"string","format":"date-time"},"channel":{"$ref":"#/definitions/KapuaDataChannel"},"clientId":{"type":"string"},"deviceId":{"$ref":"#/definitions/KapuaId"},"receivedOn":{"type":"string","format":"date-time"},"sentOn":{"type":"string","format":"date-time"},"datastoreId":{"$ref":"#/definitions/StorableId"}},"xml":{"name":"message"}},"KapuaDataChannel":{"type":"object","properties":{"semanticParts":{"type":"array","items":{"type":"string"}}},"xml":{"name":"channel"}},"KapuaPayload":{"type":"object","properties":{"metrics":{"type":"object","additionalProperties":{"type":"object"}},"body":{"type":"array","items":{"type":"string","format":"byte","xml":{"name":"body"}}}},"xml":{"name":"payload"}},"KapuaPosition":{"type":"object","properties":{"precision":{"type":"number","format":"double"},"timestamp":{"type":"string","format":"date-time"},"status":{"type":"integer","format":"int32"},"latitude":{"type":"number","format":"double"},"altitude":{"type":"number","format":"double"},"heading":{"type":"number","format":"double"},"speed":{"type":"number","format":"double"},"satellites":{"type":"integer","format":"int32"},"longitude":{"type":"number","format":"double"}},"xml":{"name":"position"}},"MessageListResult":{"type":"object","properties":{"items":{"type":"array","xml":{"wrapped":true},"items":{"xml":{"name":"item"},"$ref":"#/definitions/DatastoreMessage"}},"limitExceeded":{"type":"boolean"},"firstItem":{"$ref":"#/definitions/DatastoreMessage"},"nextKey":{"type":"object"},"totalCount":{"type":"integer","format":"int64"},"empty":{"type":"boolean"},"size":{"type":"integer","format":"int32"}},"xml":{"name":"datastoreMessages"}},"KapuaDataMessage":{"type":"object","properties":{"position":{"$ref":"#/definitions/KapuaPosition"},"payload":{"$ref":"#/definitions/KapuaDataPayload"},"scopeId":{"type":"string"},"id":{"type":"string","format":"uuid"},"capturedOn":{"type":"string","format":"date-time"},"channel":{"$ref":"#/definitions/KapuaDataChannel"},"clientId":{"type":"string"},"deviceId":{"type":"string"},"receivedOn":{"type":"string","format":"date-time"},"sentOn":{"type":"string","format":"date-time"}},"xml":{"name":"dataMessage"}},"KapuaDataPayload":{"type":"object","properties":{"metrics":{"type":"object","additionalProperties":{"type":"object"}},"body":{"type":"array","items":{"type":"string","format":"byte","xml":{"name":"body"}}}},"xml":{"name":"payload"}},"MessageQuery":{"type":"object","properties":{"limit":{"type":"integer","format":"int32"},"scopeId":{"$ref":"#/definitions/KapuaId"},"fetchAttributes":{"type":"array","xml":{"name":"fetchAttributeName","wrapped":true},"items":{"type":"string","xml":{"name":"fetchAttributeName"}}},"predicate":{"$ref":"#/definitions/StorablePredicate"},"askTotalCount":{"type":"boolean"},"fetchStyle":{"type":"string","enum":["FIELDS","SOURCE_SELECT","SOURCE_FULL"]},"sortFields":{"type":"array","items":{"$ref":"#/definitions/SortField"}},"offset":{"type":"integer","format":"int32"}},"xml":{"name":"query"}},"JsonKapuaDataMessage":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"scopeId":{"type":"string"},"deviceId":{"type":"string"},"clientId":{"type":"string"},"receivedOn":{"type":"string","format":"date-time"},"sentOn":{"type":"string","format":"date-time"},"capturedOn":{"type":"string","format":"date-time"},"position":{"$ref":"#/definitions/KapuaPosition"},"channel":{"$ref":"#/definitions/KapuaDataChannel"},"payload":{"$ref":"#/definitions/JsonKapuaPayload"}}},"JsonKapuaPayload":{"type":"object","properties":{"metrics":{"type":"array","xml":{"wrapped":true},"items":{"xml":{"name":"metric"},"$ref":"#/definitions/XmlAdaptedMetric"}},"body":{"type":"array","items":{"type":"string","format":"byte","xml":{"name":"body"}}}},"xml":{"name":"payload"}},"XmlAdaptedMetric":{"type":"object","properties":{"value":{"type":"string"},"name":{"type":"string"},"castedValue":{"type":"object"}},"xml":{"name":"metric"}},"MetricInfo":{"type":"object","properties":{"scopeId":{"type":"string"},"id":{"$ref":"#/definitions/StorableId"},"channel":{"type":"string"},"clientId":{"type":"string"},"lastMessageOn":{"type":"string","format":"date-time"},"firstMessageId":{"$ref":"#/definitions/StorableId"},"firstMessageOn":{"type":"string","format":"date-time"},"lastMessageId":{"$ref":"#/definitions/StorableId"},"name":{"type":"string"}},"xml":{"name":"metricInfo"}},"MetricInfoListResult":{"type":"object","properties":{"items":{"type":"array","xml":{"wrapped":true},"items":{"xml":{"name":"item"},"$ref":"#/definitions/MetricInfo"}},"limitExceeded":{"type":"boolean"},"firstItem":{"$ref":"#/definitions/MetricInfo"},"nextKey":{"type":"object"},"totalCount":{"type":"integer","format":"int64"},"empty":{"type":"boolean"},"size":{"type":"integer","format":"int32"}},"xml":{"name":"metricInfos"}},"MetricInfoQuery":{"type":"object","properties":{"limit":{"type":"integer","format":"int32"},"scopeId":{"$ref":"#/definitions/KapuaId"},"fetchAttributes":{"type":"array","xml":{"name":"fetchAttributeName","wrapped":true},"items":{"type":"string","xml":{"name":"fetchAttributeName"}}},"predicate":{"$ref":"#/definitions/StorablePredicate"},"askTotalCount":{"type":"boolean"},"fetchStyle":{"type":"string","enum":["FIELDS","SOURCE_SELECT","SOURCE_FULL"]},"sortFields":{"type":"array","items":{"$ref":"#/definitions/SortField"}},"offset":{"type":"integer","format":"int32"}},"xml":{"name":"query"}},"DeviceConnectionOption":{"type":"object","properties":{"allowUserChange":{"type":"boolean"},"userCouplingMode":{"type":"string","enum":["INHERITED","LOOSE","STRICT"]},"reservedUserId":{"$ref":"#/definitions/KapuaId"},"type":{"type":"string"},"modifiedOn":{"type":"string","format":"date-time"},"modifiedBy":{"type":"string"},"optlock":{"type":"integer","format":"int32"},"entityAttributes":{"type":"object","additionalProperties":{"type":"string"}},"entityProperties":{"type":"object","additionalProperties":{"type":"string"}},"scopeId":{"type":"string"},"id":{"type":"string"},"createdBy":{"type":"string"},"createdOn":{"type":"string","format":"date-time"}},"xml":{"name":"deviceConnectionOption"}},"DeviceConnection":{"type":"object","properties":{"protocol":{"type":"string"},"status":{"type":"string","enum":["CONNECTED","DISCONNECTED","MISSING","NULL"]},"userId":{"type":"string"},"clientId":{"type":"string"},"serverIp":{"type":"string"},"allowUserChange":{"type":"boolean"},"userCouplingMode":{"type":"string","enum":["INHERITED","LOOSE","STRICT"]},"reservedUserId":{"type":"string"},"clientIp":{"type":"string"},"type":{"type":"string"},"modifiedOn":{"type":"string","format":"date-time"},"modifiedBy":{"type":"string"},"optlock":{"type":"integer","format":"int32"},"entityAttributes":{"type":"object","additionalProperties":{"type":"string"}},"entityProperties":{"type":"object","additionalProperties":{"type":"string"}},"scopeId":{"type":"string"},"id":{"type":"string"},"createdBy":{"type":"string"},"createdOn":{"type":"string","format":"date-time"}},"xml":{"name":"deviceConnection"}},"DeviceConnectionListResult":{"type":"object","properties":{"items":{"type":"array","xml":{"wrapped":true},"items":{"xml":{"name":"item"},"$ref":"#/definitions/DeviceConnection"}},"limitExceeded":{"type":"boolean"},"firstItem":{"$ref":"#/definitions/DeviceConnection"},"empty":{"type":"boolean"},"size":{"type":"integer","format":"int32"}},"xml":{"name":"deviceConnections"}},"DeviceConnectionQuery":{"type":"object","properties":{"limit":{"type":"integer","format":"int32"},"scopeId":{"type":"string"},"fetchAttributes":{"type":"array","xml":{"name":"fetchAttributeName","wrapped":true},"items":{"type":"string","xml":{"name":"fetchAttributeName"}}},"predicate":{"$ref":"#/definitions/QueryPredicate"},"sortCriteria":{"$ref":"#/definitions/KapuaSortCriteria"},"offset":{"type":"integer","format":"int32"}},"xml":{"name":"query"}},"DeviceEvent":{"type":"object","properties":{"responseCode":{"type":"string","enum":["ACCEPTED","BAD_REQUEST","NOT_FOUND","INTERNAL_ERROR"]},"position":{"$ref":"#/definitions/KapuaPosition"},"action":{"type":"string","enum":["READ","CREATE","WRITE","DELETE","OPTIONS","EXECUTE"]},"resource":{"type":"string"},"deviceId":{"type":"string"},"receivedOn":{"type":"string","format":"date-time"},"sentOn":{"type":"string","format":"date-time"},"eventMessage":{"type":"string"},"type":{"type":"string"},"scopeId":{"type":"string"},"id":{"type":"string"},"createdBy":{"type":"string"},"createdOn":{"type":"string","format":"date-time"}},"xml":{"name":"deviceEvent"}},"DeviceEventListResult":{"type":"object","properties":{"items":{"type":"array","xml":{"wrapped":true},"items":{"xml":{"name":"item"},"$ref":"#/definitions/DeviceEvent"}},"limitExceeded":{"type":"boolean"},"firstItem":{"$ref":"#/definitions/DeviceEvent"},"empty":{"type":"boolean"},"size":{"type":"integer","format":"int32"}},"xml":{"name":"deviceEventListResult"}},"DeviceEventQuery":{"type":"object","properties":{"limit":{"type":"integer","format":"int32"},"scopeId":{"type":"string"},"fetchAttributes":{"type":"array","xml":{"name":"fetchAttributeName","wrapped":true},"items":{"type":"string","xml":{"name":"fetchAttributeName"}}},"predicate":{"$ref":"#/definitions/QueryPredicate"},"sortCriteria":{"$ref":"#/definitions/KapuaSortCriteria"},"offset":{"type":"integer","format":"int32"}},"xml":{"name":"query"}},"DeviceAsset":{"type":"object","properties":{"channels":{"type":"array","xml":{"wrapped":true},"items":{"xml":{"name":"channel"},"$ref":"#/definitions/DeviceAssetChannel"}},"name":{"type":"string"}},"xml":{"name":"deviceAsset"}},"DeviceAssetChannel":{"type":"object","properties":{"mode":{"type":"string","enum":["WRITE","READ","READ_WRITE"]},"timestamp":{"type":"string","format":"date-time"},"error":{"type":"string"},"name":{"type":"string"},"value":{"type":"object"}}},"DeviceAssets":{"type":"object","properties":{"assets":{"type":"array","xml":{"name":"deviceAsset"},"items":{"xml":{"name":"deviceAsset"},"$ref":"#/definitions/DeviceAsset"}}},"xml":{"name":"deviceAssets"}},"DeviceBundle":{"type":"object","properties":{"version":{"type":"string"},"state":{"type":"string"},"id":{"type":"integer","format":"int64"},"name":{"type":"string"}},"xml":{"name":"bundle"}},"DeviceBundles":{"type":"object","properties":{"bundles":{"type":"array","xml":{"name":"bundle"},"items":{"xml":{"name":"bundle"},"$ref":"#/definitions/DeviceBundle"}}},"xml":{"name":"bundles"}},"DeviceCommandOutput":{"type":"object","properties":{"exceptionStack":{"type":"string"},"exceptionMessage":{"type":"string"},"stderr":{"type":"string"},"stdout":{"type":"string"},"exitCode":{"type":"integer","format":"int32"},"hasTimedout":{"type":"boolean"}},"xml":{"name":"commandOutput"}},"DeviceCommandInput":{"type":"object","properties":{"environment":{"type":"array","items":{"type":"string","xml":{"name":"environment"}}},"password":{"type":"string"},"timeout":{"type":"integer","format":"int32"},"runAsynch":{"type":"boolean"},"arguments":{"type":"array","xml":{"wrapped":true},"items":{"type":"string","xml":{"name":"argument"}}},"body":{"type":"array","items":{"type":"string","format":"byte","xml":{"name":"body"}}},"command":{"type":"string"},"stdin":{"type":"string"},"workingDir":{"type":"string"},"scopeId":{"type":"string"},"id":{"type":"string"},"createdBy":{"type":"string"},"createdOn":{"type":"string","format":"date-time"},"type":{"type":"string"}},"xml":{"name":"commandInput"}},"DeviceComponentConfiguration":{"type":"object","properties":{"id":{"type":"string"},"definition":{"$ref":"#/definitions/KapuaTocd"},"name":{"type":"string","xml":{"attribute":true}},"properties":{"type":"object","additionalProperties":{"type":"object"}}},"xml":{"name":"configuration"}},"DeviceConfiguration":{"type":"object","properties":{"componentConfigurations":{"type":"array","xml":{"name":"configuration"},"items":{"xml":{"name":"configuration"},"$ref":"#/definitions/DeviceComponentConfiguration"}}},"xml":{"name":"configurations"}},"KapuaTad":{"type":"object","properties":{"option":{"type":"array","xml":{"name":"Option","namespace":"http://www.osgi.org/xmlns/metatype/v1.2.0"},"items":{"xml":{"name":"Option"},"$ref":"#/definitions/KapuaToption"}},"type":{"$ref":"#/definitions/KapuaTscalar"},"default":{"type":"string","xml":{"attribute":true}},"required":{"type":"boolean","xml":{"attribute":true}},"min":{"type":"string","xml":{"attribute":true}},"max":{"type":"string","xml":{"attribute":true}},"description":{"type":"string","xml":{"attribute":true}},"id":{"type":"string","xml":{"attribute":true}},"otherAttributes":{"type":"object","additionalProperties":{"type":"string"}},"cardinality":{"type":"integer","format":"int32","xml":{"attribute":true}},"any":{"type":"array","items":{"type":"object"}},"name":{"type":"string","xml":{"attribute":true}}},"xml":{"name":"AD","namespace":"http://www.osgi.org/xmlns/metatype/v1.2.0"}},"KapuaTicon":{"type":"object","properties":{"otherAttributes":{"type":"object","additionalProperties":{"type":"string"}},"any":{"type":"array","items":{"type":"object"}},"resource":{"type":"string","xml":{"attribute":true}},"size":{"type":"integer","xml":{"attribute":true}}},"xml":{"name":"Icon","namespace":"http://www.osgi.org/xmlns/metatype/v1.2.0"}},"KapuaTocd":{"type":"object","required":["ad"],"properties":{"icon":{"type":"array","xml":{"name":"Icon","namespace":"http://www.osgi.org/xmlns/metatype/v1.2.0"},"items":{"xml":{"name":"Icon"},"$ref":"#/definitions/KapuaTicon"}},"description":{"type":"string","xml":{"attribute":true}},"id":{"type":"string","xml":{"attribute":true}},"ad":{"type":"array","xml":{"name":"AD","namespace":"http://www.osgi.org/xmlns/metatype/v1.2.0"},"items":{"xml":{"name":"AD"},"$ref":"#/definitions/KapuaTad"}},"otherAttributes":{"type":"object","additionalProperties":{"type":"string"}},"any":{"type":"array","items":{"type":"object"}},"name":{"type":"string","xml":{"attribute":true}}},"xml":{"name":"OCD","namespace":"http://www.osgi.org/xmlns/metatype/v1.2.0"}},"KapuaToption":{"type":"object","properties":{"otherAttributes":{"type":"object","additionalProperties":{"type":"string"}},"any":{"type":"array","items":{"type":"object"}},"label":{"type":"string","xml":{"attribute":true}},"value":{"type":"string","xml":{"attribute":true}}},"xml":{"name":"Option","namespace":"http://www.osgi.org/xmlns/metatype/v1.2.0"}},"KapuaTscalar":{"type":"object"},"DevicePackageDownloadRequest":{"type":"object","properties":{"version":{"type":"string"},"uri":{"type":"string","format":"uri"},"reboot":{"type":"boolean"},"rebootDelay":{"type":"integer","format":"int32"},"install":{"type":"boolean"},"name":{"type":"string"}},"xml":{"name":"downloadRequest"}},"DevicePackageUninstallRequest":{"type":"object","properties":{"version":{"type":"string"},"reboot":{"type":"boolean"},"rebootDelay":{"type":"integer","format":"int32"},"name":{"type":"string"}},"xml":{"name":"uninstallRequest"}},"DeviceSnapshot":{"type":"object","properties":{"timestamp":{"type":"integer","format":"int64"},"id":{"type":"string"}},"xml":{"name":"snapshot"}},"DeviceSnapshots":{"type":"object","properties":{"snapshots":{"type":"array","xml":{"name":"snapshotId"},"items":{"xml":{"name":"snapshotId"},"$ref":"#/definitions/DeviceSnapshot"}}},"xml":{"name":"snapshots"}},"GenericRequestChannel":{"type":"object","properties":{"resources":{"type":"array","xml":{"wrapped":true},"items":{"type":"string","xml":{"name":"resource"}}},"method":{"type":"string","enum":["READ","CREATE","WRITE","DELETE","OPTIONS","EXECUTE"]},"version":{"$ref":"#/definitions/KapuaAppProperties"},"appName":{"$ref":"#/definitions/KapuaAppProperties"},"semanticParts":{"type":"array","items":{"type":"string"}}},"xml":{"name":"channel"}},"GenericRequestMessage":{"type":"object","properties":{"position":{"$ref":"#/definitions/KapuaPosition"},"payload":{"$ref":"#/definitions/GenericRequestPayload"},"scopeId":{"type":"string"},"id":{"type":"string","format":"uuid"},"capturedOn":{"type":"string","format":"date-time"},"channel":{"$ref":"#/definitions/GenericRequestChannel"},"clientId":{"type":"string"},"deviceId":{"type":"string"},"receivedOn":{"type":"string","format":"date-time"},"sentOn":{"type":"string","format":"date-time"}},"xml":{"name":"genericRequestMessage"}},"GenericRequestPayload":{"type":"object","properties":{"metrics":{"type":"object","additionalProperties":{"type":"object"}},"body":{"type":"array","items":{"type":"string","format":"byte","xml":{"name":"body"}}}},"xml":{"name":"payload"}},"KapuaAppProperties":{"type":"object","properties":{"value":{"type":"string"}}},"JsonGenericRequestMessage":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"scopeId":{"type":"string"},"deviceId":{"type":"string"},"clientId":{"type":"string"},"receivedOn":{"type":"string","format":"date-time"},"sentOn":{"type":"string","format":"date-time"},"capturedOn":{"type":"string","format":"date-time"},"position":{"$ref":"#/definitions/KapuaPosition"},"channel":{"$ref":"#/definitions/GenericRequestChannel"},"payload":{"$ref":"#/definitions/JsonKapuaPayload"}}},"Device":{"type":"object","properties":{"osVersion":{"type":"string"},"serialNumber":{"type":"string"},"displayName":{"type":"string"},"lastEvent":{"$ref":"#/definitions/DeviceEvent"},"connection":{"$ref":"#/definitions/DeviceConnection"},"status":{"type":"string","enum":["ENABLED","DISABLED"]},"groupId":{"type":"string"},"clientId":{"type":"string"},"firmwareVersion":{"type":"string"},"modelId":{"type":"string"},"biosVersion":{"type":"string"},"jvmVersion":{"type":"string"},"applicationFrameworkVersion":{"type":"string"},"connectionInterface":{"type":"string"},"connectionIp":{"type":"string"},"acceptEncoding":{"type":"string"},"applicationIdentifiers":{"type":"string"},"connectionId":{"type":"string"},"lastEventId":{"type":"string"},"imei":{"type":"string"},"imsi":{"type":"string"},"iccid":{"type":"string"},"osgiFrameworkVersion":{"type":"string"},"customAttribute1":{"type":"string"},"tagIds":{"type":"string","xml":{"wrapped":true}},"customAttribute2":{"type":"string"},"customAttribute3":{"type":"string"},"customAttribute4":{"type":"string"},"customAttribute5":{"type":"string"},"type":{"type":"string"},"modifiedOn":{"type":"string","format":"date-time"},"modifiedBy":{"type":"string"},"optlock":{"type":"integer","format":"int32"},"entityAttributes":{"type":"object","additionalProperties":{"type":"string"}},"entityProperties":{"type":"object","additionalProperties":{"type":"string"}},"scopeId":{"type":"string"},"id":{"type":"string"},"createdBy":{"type":"string"},"createdOn":{"type":"string","format":"date-time"}},"xml":{"name":"device"}},"DeviceListResult":{"type":"object","properties":{"items":{"type":"array","xml":{"wrapped":true},"items":{"xml":{"name":"item"},"$ref":"#/definitions/Device"}},"limitExceeded":{"type":"boolean"},"firstItem":{"$ref":"#/definitions/Device"},"empty":{"type":"boolean"},"size":{"type":"integer","format":"int32"}},"xml":{"name":"devices"}},"DeviceQuery":{"type":"object","properties":{"limit":{"type":"integer","format":"int32"},"scopeId":{"type":"string"},"fetchAttributes":{"type":"array","xml":{"name":"fetchAttributeName","wrapped":true},"items":{"type":"string","xml":{"name":"fetchAttributeName"}}},"predicate":{"$ref":"#/definitions/QueryPredicate"},"sortCriteria":{"$ref":"#/definitions/KapuaSortCriteria"},"offset":{"type":"integer","format":"int32"}},"xml":{"name":"query"}},"DeviceCreator":{"type":"object","properties":{"osVersion":{"type":"string"},"serialNumber":{"type":"string"},"displayName":{"type":"string"},"status":{"type":"string","enum":["ENABLED","DISABLED"]},"groupId":{"type":"string"},"clientId":{"type":"string"},"firmwareVersion":{"type":"string"},"modelId":{"type":"string"},"biosVersion":{"type":"string"},"jvmVersion":{"type":"string"},"applicationFrameworkVersion":{"type":"string"},"connectionInterface":{"type":"string"},"connectionIp":{"type":"string"},"acceptEncoding":{"type":"string"},"applicationIdentifiers":{"type":"string"},"connectionId":{"type":"string"},"lastEventId":{"type":"string"},"imei":{"type":"string"},"imsi":{"type":"string"},"iccid":{"type":"string"},"osgiFrameworkVersion":{"type":"string"},"customAttribute1":{"type":"string"},"customAttribute2":{"type":"string"},"customAttribute3":{"type":"string"},"customAttribute4":{"type":"string"},"customAttribute5":{"type":"string"},"entityAttributes":{"type":"object","additionalProperties":{"type":"string"}},"scopeId":{"type":"string"}},"xml":{"name":"deviceCreator"}},"Domain":{"type":"object","properties":{"domain":{"$ref":"#/definitions/Domain"},"groupable":{"type":"boolean"},"actions":{"type":"array","xml":{"wrapped":true},"uniqueItems":true,"items":{"type":"string","xml":{"name":"action"},"enum":["read","write","delete","connect","execute"]}},"name":{"type":"string"},"type":{"type":"string"},"scopeId":{"type":"string"},"id":{"type":"string"},"createdBy":{"type":"string"},"createdOn":{"type":"string","format":"date-time"}},"xml":{"name":"domain"}},"DomainListResult":{"type":"object","properties":{"items":{"type":"array","xml":{"wrapped":true},"items":{"xml":{"name":"item"},"$ref":"#/definitions/Domain"}},"limitExceeded":{"type":"boolean"},"firstItem":{"$ref":"#/definitions/Domain"},"empty":{"type":"boolean"},"size":{"type":"integer","format":"int32"}},"xml":{"name":"domains"}},"DomainQuery":{"type":"object","properties":{"limit":{"type":"integer","format":"int32"},"scopeId":{"type":"string"},"fetchAttributes":{"type":"array","xml":{"name":"fetchAttributeName","wrapped":true},"items":{"type":"string","xml":{"name":"fetchAttributeName"}}},"predicate":{"$ref":"#/definitions/QueryPredicate"},"sortCriteria":{"$ref":"#/definitions/KapuaSortCriteria"},"offset":{"type":"integer","format":"int32"}},"xml":{"name":"query"}},"EndpointInfo":{"type":"object","properties":{"schema":{"type":"string"},"port":{"type":"integer","format":"int32"},"secure":{"type":"boolean"},"dns":{"type":"string"},"usages":{"type":"array","uniqueItems":true,"items":{"xml":{"name":"usages"},"$ref":"#/definitions/EndpointUsage"}},"type":{"type":"string"},"modifiedOn":{"type":"string","format":"date-time"},"modifiedBy":{"type":"string"},"optlock":{"type":"integer","format":"int32"},"entityAttributes":{"type":"object","additionalProperties":{"type":"string"}},"entityProperties":{"type":"object","additionalProperties":{"type":"string"}},"scopeId":{"type":"string"},"id":{"type":"string"},"createdBy":{"type":"string"},"createdOn":{"type":"string","format":"date-time"}},"xml":{"name":"endpointInfo"}},"EndpointInfoListResult":{"type":"object","properties":{"items":{"type":"array","xml":{"wrapped":true},"items":{"xml":{"name":"item"},"$ref":"#/definitions/EndpointInfo"}},"limitExceeded":{"type":"boolean"},"firstItem":{"$ref":"#/definitions/EndpointInfo"},"empty":{"type":"boolean"},"size":{"type":"integer","format":"int32"}},"xml":{"name":"endpointInfos"}},"EndpointUsage":{"type":"object","properties":{"name":{"type":"string"}},"xml":{"name":"endpointUsage"}},"EndpointInfoQuery":{"type":"object","properties":{"limit":{"type":"integer","format":"int32"},"scopeId":{"type":"string"},"fetchAttributes":{"type":"array","xml":{"name":"fetchAttributeName","wrapped":true},"items":{"type":"string","xml":{"name":"fetchAttributeName"}}},"predicate":{"$ref":"#/definitions/QueryPredicate"},"sortCriteria":{"$ref":"#/definitions/KapuaSortCriteria"},"offset":{"type":"integer","format":"int32"}},"xml":{"name":"query"}},"EndpointInfoCreator":{"type":"object","properties":{"schema":{"type":"string"},"port":{"type":"integer","format":"int32"},"secure":{"type":"boolean"},"dns":{"type":"string"},"usages":{"type":"array","uniqueItems":true,"items":{"$ref":"#/definitions/EndpointUsage"}},"scopeId":{"type":"string"}},"xml":{"name":"endpointInfoCreator"}},"Group":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"modifiedOn":{"type":"string","format":"date-time"},"modifiedBy":{"type":"string"},"optlock":{"type":"integer","format":"int32"},"entityAttributes":{"type":"object","additionalProperties":{"type":"string"}},"entityProperties":{"type":"object","additionalProperties":{"type":"string"}},"scopeId":{"type":"string"},"id":{"type":"string"},"createdBy":{"type":"string"},"createdOn":{"type":"string","format":"date-time"}},"xml":{"name":"group"}},"GroupListResult":{"type":"object","properties":{"items":{"type":"array","xml":{"wrapped":true},"items":{"xml":{"name":"item"},"$ref":"#/definitions/Group"}},"limitExceeded":{"type":"boolean"},"firstItem":{"$ref":"#/definitions/Group"},"empty":{"type":"boolean"},"size":{"type":"integer","format":"int32"}},"xml":{"name":"groups"}},"GroupQuery":{"type":"object","properties":{"limit":{"type":"integer","format":"int32"},"scopeId":{"type":"string"},"fetchAttributes":{"type":"array","xml":{"name":"fetchAttributeName","wrapped":true},"items":{"type":"string","xml":{"name":"fetchAttributeName"}}},"predicate":{"$ref":"#/definitions/QueryPredicate"},"sortCriteria":{"$ref":"#/definitions/KapuaSortCriteria"},"offset":{"type":"integer","format":"int32"}},"xml":{"name":"query"}},"GroupCreator":{"type":"object","properties":{"name":{"type":"string"},"scopeId":{"type":"string"}},"xml":{"name":"groupCreator"}},"Role":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"modifiedOn":{"type":"string","format":"date-time"},"modifiedBy":{"type":"string"},"optlock":{"type":"integer","format":"int32"},"entityAttributes":{"type":"object","additionalProperties":{"type":"string"}},"entityProperties":{"type":"object","additionalProperties":{"type":"string"}},"scopeId":{"type":"string"},"id":{"type":"string"},"createdBy":{"type":"string"},"createdOn":{"type":"string","format":"date-time"}},"xml":{"name":"role"}},"RoleListResult":{"type":"object","properties":{"items":{"type":"array","xml":{"wrapped":true},"items":{"xml":{"name":"item"},"$ref":"#/definitions/Role"}},"limitExceeded":{"type":"boolean"},"firstItem":{"$ref":"#/definitions/Role"},"empty":{"type":"boolean"},"size":{"type":"integer","format":"int32"}},"xml":{"name":"roles"}},"RoleQuery":{"type":"object","properties":{"limit":{"type":"integer","format":"int32"},"scopeId":{"type":"string"},"fetchAttributes":{"type":"array","xml":{"name":"fetchAttributeName","wrapped":true},"items":{"type":"string","xml":{"name":"fetchAttributeName"}}},"predicate":{"$ref":"#/definitions/QueryPredicate"},"sortCriteria":{"$ref":"#/definitions/KapuaSortCriteria"},"offset":{"type":"integer","format":"int32"}},"xml":{"name":"query"}},"RoleCreator":{"type":"object","properties":{"permissions":{"type":"array","xml":{"wrapped":true},"uniqueItems":true,"items":{"xml":{"name":"permission"},"$ref":"#/definitions/Permission"}},"name":{"type":"string"},"scopeId":{"type":"string"}},"xml":{"name":"roleCreator"}},"RolePermission":{"type":"object","properties":{"roleId":{"type":"string"},"type":{"type":"string"},"permission":{"$ref":"#/definitions/Permission"},"scopeId":{"type":"string"},"id":{"type":"string"},"createdBy":{"type":"string"},"createdOn":{"type":"string","format":"date-time"}},"xml":{"name":"rolePermission"}},"RolePermissionListResult":{"type":"object","properties":{"items":{"type":"array","xml":{"wrapped":true},"items":{"xml":{"name":"item"},"$ref":"#/definitions/RolePermission"}},"limitExceeded":{"type":"boolean"},"firstItem":{"$ref":"#/definitions/RolePermission"},"empty":{"type":"boolean"},"size":{"type":"integer","format":"int32"}},"xml":{"name":"rolePermissions"}},"RolePermissionQuery":{"type":"object","properties":{"limit":{"type":"integer","format":"int32"},"scopeId":{"type":"string"},"fetchAttributes":{"type":"array","xml":{"name":"fetchAttributeName","wrapped":true},"items":{"type":"string","xml":{"name":"fetchAttributeName"}}},"predicate":{"$ref":"#/definitions/QueryPredicate"},"sortCriteria":{"$ref":"#/definitions/KapuaSortCriteria"},"offset":{"type":"integer","format":"int32"}},"xml":{"name":"query"}},"RolePermissionCreator":{"type":"object","properties":{"roleId":{"type":"string"},"permission":{"$ref":"#/definitions/Permission"},"scopeId":{"type":"string"}},"xml":{"name":"rolePermissionCreator"}},"Tag":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"modifiedOn":{"type":"string","format":"date-time"},"modifiedBy":{"type":"string"},"optlock":{"type":"integer","format":"int32"},"entityAttributes":{"type":"object","additionalProperties":{"type":"string"}},"entityProperties":{"type":"object","additionalProperties":{"type":"string"}},"scopeId":{"type":"string"},"id":{"type":"string"},"createdBy":{"type":"string"},"createdOn":{"type":"string","format":"date-time"}},"xml":{"name":"tag"}},"TagListResult":{"type":"object","properties":{"items":{"type":"array","xml":{"wrapped":true},"items":{"xml":{"name":"item"},"$ref":"#/definitions/Tag"}},"limitExceeded":{"type":"boolean"},"firstItem":{"$ref":"#/definitions/Tag"},"empty":{"type":"boolean"},"size":{"type":"integer","format":"int32"}},"xml":{"name":"tags"}},"TagQuery":{"type":"object","properties":{"limit":{"type":"integer","format":"int32"},"scopeId":{"type":"string"},"fetchAttributes":{"type":"array","xml":{"name":"fetchAttributeName","wrapped":true},"items":{"type":"string","xml":{"name":"fetchAttributeName"}}},"predicate":{"$ref":"#/definitions/QueryPredicate"},"sortCriteria":{"$ref":"#/definitions/KapuaSortCriteria"},"offset":{"type":"integer","format":"int32"}},"xml":{"name":"query"}},"TagCreator":{"type":"object","properties":{"name":{"type":"string"},"scopeId":{"type":"string"}},"xml":{"name":"tagCreator"}},"User":{"type":"object","properties":{"displayName":{"type":"string"},"status":{"type":"string","enum":["ENABLED","DISABLED"]},"expirationDate":{"type":"string","format":"date-time"},"email":{"type":"string"},"phoneNumber":{"type":"string"},"userType":{"type":"string","enum":["DEVICE","INTERNAL","EXTERNAL"]},"externalId":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"},"modifiedOn":{"type":"string","format":"date-time"},"modifiedBy":{"type":"string"},"optlock":{"type":"integer","format":"int32"},"entityAttributes":{"type":"object","additionalProperties":{"type":"string"}},"entityProperties":{"type":"object","additionalProperties":{"type":"string"}},"scopeId":{"type":"string"},"id":{"type":"string"},"createdBy":{"type":"string"},"createdOn":{"type":"string","format":"date-time"}},"xml":{"name":"user"}},"UserListResult":{"type":"object","properties":{"items":{"type":"array","xml":{"wrapped":true},"items":{"xml":{"name":"item"},"$ref":"#/definitions/User"}},"limitExceeded":{"type":"boolean"},"firstItem":{"$ref":"#/definitions/User"},"empty":{"type":"boolean"},"size":{"type":"integer","format":"int32"}},"xml":{"name":"users"}},"UserQuery":{"type":"object","properties":{"limit":{"type":"integer","format":"int32"},"scopeId":{"type":"string"},"fetchAttributes":{"type":"array","xml":{"name":"fetchAttributeName","wrapped":true},"items":{"type":"string","xml":{"name":"fetchAttributeName"}}},"predicate":{"$ref":"#/definitions/QueryPredicate"},"sortCriteria":{"$ref":"#/definitions/KapuaSortCriteria"},"offset":{"type":"integer","format":"int32"}},"xml":{"name":"query"}},"UserCreator":{"type":"object","properties":{"displayName":{"type":"string"},"expirationDate":{"type":"string","format":"date-time"},"email":{"type":"string"},"phoneNumber":{"type":"string"},"userType":{"type":"string","enum":["DEVICE","INTERNAL","EXTERNAL"]},"externalId":{"type":"string"},"userStatus":{"type":"string","enum":["ENABLED","DISABLED"]},"name":{"type":"string"},"entityAttributes":{"type":"object","additionalProperties":{"type":"string"}},"scopeId":{"type":"string"}},"xml":{"name":"userCreator"}}}}