{"openapi":"3.0.2","info":{"contact":{"name":"IXON B.V.","url":"https://www.ixon.cloud/","email":"support@ixon.cloud"},"description":"API for the IXON Cloud Platform","license":{"name":"All Rights Reserved","url":"https://www.ixon.cloud/"},"title":"IXON API","version":"0.1.294"},"servers":[{"description":"IXON Cloud platform server","url":"https://portal.ixon.cloud:443/api/"}],"paths":{"/access-recover":{"post":{"tags":["AccessRecoverList"],"summary":"AccessRecoverList","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingRequired"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"emailAddress":{"maxLength":254,"minLength":6,"nullable":false,"pattern":"^(?=.{1,254}$)(?=.{1,64}@)[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+(?:\\.[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+)*@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$","type":"string"}},"required":["emailAddress"]}}}}}},"/access-tokens/{publicId}":{"get":{"tags":["AccessToken"],"summary":"AccessToken","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"expiresOn":{"nullable":false,"type":"string","format":"date-time"},"geoLocation":{"nullable":false,"type":"object","properties":{"latitude":{"nullable":false,"type":"string"},"longitude":{"nullable":false,"type":"string"},"country":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"city":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"created":{"nullable":false,"type":"object","properties":{"ip":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"on":{"nullable":false,"type":"string","format":"date-time"},"userAgent":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"}}},"scope":{"oneOf":[{"type":"object","properties":{"type":{"enum":["unrestricted"],"nullable":false,"type":"string"}},"required":["type"]},{"type":"object","properties":{"type":{"enum":["allow"],"nullable":false,"type":"string"},"rels":{"type":"array","items":{"nullable":false,"type":"object","properties":{"rel":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"get":{"nullable":true,"type":"boolean"},"post":{"nullable":true,"type":"boolean"},"patch":{"nullable":true,"type":"boolean"},"delete":{"nullable":true,"type":"boolean"},"put":{"nullable":true,"type":"boolean"}}}}},"required":["type","rels"]},{"type":"object","properties":{"type":{"enum":["deny"],"nullable":false,"type":"string"},"rels":{"type":"array","items":{"nullable":false,"type":"object","properties":{"rel":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"get":{"nullable":true,"type":"boolean"},"post":{"nullable":true,"type":"boolean"},"patch":{"nullable":true,"type":"boolean"},"delete":{"nullable":true,"type":"boolean"},"put":{"nullable":true,"type":"boolean"}}}}},"required":["type","rels"]}]},"ssoIdentityProvider":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"companies":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"logo":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"delete":{"tags":["AccessToken"],"summary":"AccessToken","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/access-tokens":{"get":{"tags":["AccessTokenList"],"summary":"AccessTokenList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"expiresOn":{"nullable":false,"type":"string","format":"date-time"},"geoLocation":{"nullable":false,"type":"object","properties":{"latitude":{"nullable":false,"type":"string"},"longitude":{"nullable":false,"type":"string"},"country":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"city":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"created":{"nullable":false,"type":"object","properties":{"ip":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"on":{"nullable":false,"type":"string","format":"date-time"},"userAgent":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"}}},"scope":{"oneOf":[{"type":"object","properties":{"type":{"enum":["unrestricted"],"nullable":false,"type":"string"}},"required":["type"]},{"type":"object","properties":{"type":{"enum":["allow"],"nullable":false,"type":"string"},"rels":{"type":"array","items":{"nullable":false,"type":"object","properties":{"rel":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"get":{"nullable":true,"type":"boolean"},"post":{"nullable":true,"type":"boolean"},"patch":{"nullable":true,"type":"boolean"},"delete":{"nullable":true,"type":"boolean"},"put":{"nullable":true,"type":"boolean"}}}}},"required":["type","rels"]},{"type":"object","properties":{"type":{"enum":["deny"],"nullable":false,"type":"string"},"rels":{"type":"array","items":{"nullable":false,"type":"object","properties":{"rel":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"get":{"nullable":true,"type":"boolean"},"post":{"nullable":true,"type":"boolean"},"patch":{"nullable":true,"type":"boolean"},"delete":{"nullable":true,"type":"boolean"},"put":{"nullable":true,"type":"boolean"}}}}},"required":["type","rels"]}]},"ssoIdentityProvider":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"companies":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"logo":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"}}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"}],"security":[{"bearerToken":[]}]},"post":{"tags":["AccessTokenList"],"summary":"AccessTokenList","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"expiresOn":{"nullable":false,"type":"string","format":"date-time"},"secretId":{"maxLength":32,"minLength":32,"nullable":false,"type":"string"},"user":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"type":{"enum":["person","service_account"],"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"emailAddress":{"maxLength":254,"minLength":6,"nullable":true,"pattern":"^(?=.{1,254}$)(?=.{1,64}@)[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+(?:\\.[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+)*@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$","type":"string"},"support":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"},"hasPassword":{"nullable":false,"type":"boolean"},"externallyManaged":{"nullable":false,"type":"boolean"},"language":{"maxLength":2,"minLength":2,"nullable":false,"type":"string"},"localisation":{"maxLength":10,"minLength":1,"nullable":true,"type":"string"},"timeZone":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"registeredOn":{"nullable":false,"type":"string","format":"date-time"},"lastSeenOn":{"nullable":false,"type":"string","format":"date-time"},"registeredBy":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"emailAddressChanges":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"oldEmailAddress":{"maxLength":254,"minLength":6,"nullable":false,"pattern":"^(?=.{1,254}$)(?=.{1,64}@)[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+(?:\\.[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+)*@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$","type":"string"},"newEmailAddress":{"maxLength":254,"minLength":6,"nullable":false,"pattern":"^(?=.{1,254}$)(?=.{1,64}@)[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+(?:\\.[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+)*@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$","type":"string"},"expiresOn":{"nullable":false,"type":"string","format":"date-time"}}}},"invites":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"emailAddress":{"maxLength":254,"minLength":6,"nullable":false,"pattern":"^(?=.{1,254}$)(?=.{1,64}@)[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+(?:\\.[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+)*@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$","type":"string"},"expiresOn":{"nullable":false,"type":"string","format":"date-time"},"memberships":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"user":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"invite":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"group":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"role":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"expiresOn":{"nullable":true,"type":"string","format":"date-time"}}}}}}},"unreadMessagesCount":{"maximum":2147483647,"minimum":-2147483648,"nullable":false,"type":"integer","format":"int32"},"otpAuth":{"nullable":false,"type":"object","properties":{"required":{"nullable":false,"type":"boolean"},"deviceName":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"registeredOn":{"nullable":true,"type":"string","format":"date-time"},"tokenExpiresOn":{"nullable":true,"type":"string","format":"date-time"},"type":{"enum":["app","sms"],"nullable":true,"type":"string"}}},"apiApplications":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"custom":{"nullable":false,"type":"object"}}}},"phoneNumber":{"maxLength":16,"minLength":3,"nullable":true,"pattern":"\\+[0-9]{2,15}","type":"string"},"acceptedTermsOfUsePolicies":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"policy":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"company":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"latest":{"nullable":true,"type":"boolean"},"version":{"maxLength":5,"minLength":1,"nullable":true,"type":"string"},"publishedOn":{"nullable":true,"type":"string","format":"date-time"},"downloadUrl":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"type":{"enum":["termsofuse","privacystatement"],"nullable":false,"type":"string"},"languages":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"languageCode":{"maxLength":2,"minLength":2,"nullable":false,"type":"string"},"body":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"updateSummary":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"policy":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}}}},"company":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"acceptedOn":{"nullable":false,"type":"string","format":"date-time"}}}}}},"ssoIdentityProvider":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"companies":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"logo":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"expiresIn":{"maximum":5184000,"minimum":60,"nullable":false,"type":"integer","format":"int32"},"trustedDeviceName":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"scope":{"oneOf":[{"type":"object","properties":{"type":{"enum":["unrestricted"],"nullable":false,"type":"string"}},"required":["type"]},{"type":"object","properties":{"type":{"enum":["allow"],"nullable":false,"type":"string"},"rels":{"type":"array","items":{"nullable":false,"type":"object","properties":{"rel":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"get":{"nullable":true,"type":"boolean"},"post":{"nullable":true,"type":"boolean"},"patch":{"nullable":true,"type":"boolean"},"delete":{"nullable":true,"type":"boolean"},"put":{"nullable":true,"type":"boolean"}}}}},"required":["type","rels"]},{"type":"object","properties":{"type":{"enum":["deny"],"nullable":false,"type":"string"},"rels":{"type":"array","items":{"nullable":false,"type":"object","properties":{"rel":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"get":{"nullable":true,"type":"boolean"},"post":{"nullable":true,"type":"boolean"},"patch":{"nullable":true,"type":"boolean"},"delete":{"nullable":true,"type":"boolean"},"put":{"nullable":true,"type":"boolean"}}}}},"required":["type","rels"]}]}},"required":["expiresIn"]}}}},"security":[{"bearerToken":[]}]},"delete":{"tags":["AccessTokenList"],"summary":"AccessTokenList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/agents/{publicId}":{"get":{"tags":["Agent"],"summary":"Agent","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"deviceId":{"maxLength":128,"minLength":1,"nullable":false,"type":"string"},"type":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"additionalSubnets":{"nullable":false,"type":"boolean"},"allowDataPublishing":{"nullable":false,"type":"boolean"},"allowDemoDevice":{"nullable":false,"type":"boolean"},"allowTemplating":{"nullable":false,"type":"boolean"},"allowReboot":{"nullable":false,"type":"boolean"},"configPush":{"nullable":false,"type":"boolean"},"configFileFormat":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"customServers":{"nullable":false,"type":"boolean"},"deviceIdFormat":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"httpProxyPort":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"latestFirmwareFile":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"code":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"notes":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"agentType":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"type":{"enum":["firmware"],"nullable":false,"type":"string"},"latest":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"offlineConfiguration":{"nullable":false,"type":"boolean"},"openvpnConfigMultiUse":{"nullable":false,"type":"boolean"},"purchasePrice":{"nullable":false,"type":"object","properties":{"gratis":{"nullable":false,"type":"boolean"}}},"router":{"nullable":false,"type":"boolean"},"stunnelSupport":{"nullable":false,"type":"boolean"},"wanPortForwardings":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"},"hasSecondWanPort":{"nullable":false,"type":"boolean"}}},"location":{"nullable":true,"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"latitude":{"nullable":false,"type":"string"},"longitude":{"nullable":false,"type":"string"}}},"geoLocation":{"nullable":true,"type":"object","properties":{"latitude":{"nullable":false,"type":"string"},"longitude":{"nullable":false,"type":"string"},"country":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"city":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"timeZone":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"custom":{"nullable":false,"type":"object"},"description":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"useStunnel":{"nullable":false,"type":"boolean"},"preferLocationOverGeoip":{"nullable":false,"type":"boolean"},"reRegistration":{"nullable":false,"type":"boolean"},"replaceRegistration":{"nullable":false,"type":"boolean"},"replaceMacAddress":{"maxLength":17,"minLength":0,"nullable":true,"pattern":"[0-9a-fA-F]{2}(:[0-9a-fA-F]{2}){5}","type":"string"},"fixedVpnAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"macAddress":{"maxLength":17,"minLength":1,"nullable":false,"type":"string"},"serialNumber":{"maxLength":128,"minLength":1,"nullable":false,"type":"string"},"pullCodeGeneratedOn":{"nullable":true,"type":"string","format":"date-time"},"controlKeyGeneratedOn":{"nullable":true,"type":"string","format":"date-time"},"lastSeenAgentUserAgent":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"value":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"configName":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"configVersion":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"hardware":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"hardwareCode":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"hardwareVersion":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"firmwareVersion":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"osName":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"osVersion":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"appName":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"appVersion":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"packageName":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"packageVersion":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"libixagentVersion":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"libixloggerVersion":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"logOnTrigger":{"nullable":false,"type":"boolean"},"alarming":{"nullable":false,"type":"boolean"},"dataMonitoring":{"nullable":false,"type":"boolean"},"wifi":{"nullable":false,"type":"boolean"},"remoteFirmwareUpgrade":{"nullable":false,"type":"boolean"},"staticMapping":{"nullable":false,"type":"boolean"},"stewardConfigPush":{"nullable":false,"type":"boolean"},"wanInterfaceEth0":{"nullable":false,"type":"boolean"},"wanInterfaceWifi0":{"nullable":false,"type":"boolean"},"wanInterfaceCell0":{"enum":["3G","4G","neither"],"nullable":false,"type":"string"},"multiWan":{"nullable":false,"type":"boolean"},"openvpnVersion":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"openvpnOccEnabled":{"nullable":false,"type":"boolean"},"openvpnOpensslVersion":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"}}},"networkValues":{"type":"array","items":{"nullable":false,"type":"object","properties":{"interface":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"value":{"type":"array","items":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}}}}},"networkReportedOn":{"nullable":true,"type":"string","format":"date-time"},"activeStatus":{"enum":["active","inactive"],"nullable":false,"type":"string"},"activationLicence":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"type":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"usageType":{"enum":["advanced-user-management","agent-registration-profile","agent-templates","alarming","api-integrations","app-engine-level-1","app-engine-level-2","app-engine-level-3","asset-management","card-view","connection-monitoring","controlled-devices","custom-branding","custom-domain","custom-fields","custom-legal","custom-legal-legacy","custom-sso","edge-app-management","ixagent","landing-page","live-data","logging","m2m-cloud-cluster","main-pages","mobile-app","mqtt-device","object-storage","premium-branding","rdp","remote-access","reporting","request-access","rtsp","scim","session-recording","sla","ssh","subgroups","temporary-access","vpn-access-rule","vpn-usage"],"nullable":false,"type":"string"},"companyLimit":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"scope":{"enum":["agent","company"],"nullable":false,"type":"string"}}},"serialNumber":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"expiresOn":{"nullable":true,"type":"string","format":"date-time"},"activated":{"nullable":false,"type":"boolean"},"trial":{"nullable":false,"type":"boolean"},"value":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"locked":{"nullable":true,"type":"boolean"},"maxRetentionPolicy":{"maxLength":255,"minLength":2,"nullable":true,"type":"string"},"bundle":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}},"pendingRegistration":{"nullable":false,"type":"boolean"},"card":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"activeVpnSession":{"nullable":true,"type":"object","properties":{"rscServer":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"vpnRange":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"supportedLayers":{"type":"array","items":{"enum":["tun","tap"],"nullable":false,"type":"string"}},"location":{"nullable":false,"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"latitude":{"nullable":false,"type":"string"},"longitude":{"nullable":false,"type":"string"}}}}},"startedOn":{"nullable":false,"type":"string","format":"date-time"},"sessionName":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"vpnAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"closed":{"nullable":false,"type":"boolean"}}},"vpnChangedOn":{"nullable":true,"type":"string","format":"date-time"},"mdrServer":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"mqttChangedOn":{"nullable":true,"type":"string","format":"date-time"},"loggingMdrServer":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"loggingMqttChangedOn":{"nullable":true,"type":"string","format":"date-time"},"lsiServer":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"company":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":24,"minLength":24,"nullable":false,"pattern":"(\\d{4}-){4}\\d{4}","type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"controlledBy":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":24,"minLength":24,"nullable":false,"pattern":"(\\d{4}-){4}\\d{4}","type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"vpnAudience":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"custom":{"nullable":false,"type":"object"},"default":{"nullable":false,"type":"boolean"},"type":{"enum":["alarm","page","service"],"nullable":true,"type":"string"}}},"vpnRequireAccessApproval":{"nullable":false,"type":"boolean"},"vpnAccessRules":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"audience":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"ipAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"netMask":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}}}},"vpnVisibleInMobileApp":{"nullable":false,"type":"boolean"},"vpnVisibleOnWeb":{"nullable":false,"type":"boolean"},"dataAudience":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"custom":{"nullable":false,"type":"object"},"default":{"nullable":false,"type":"boolean"},"type":{"enum":["alarm","page","service"],"nullable":true,"type":"string"}}},"memberships":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"group":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}},"rateLimiting":{"nullable":false,"type":"object","properties":{"configMqttCommandLimit":{"enum":["soft","hard","lock"],"nullable":true,"type":"string"},"configMqttCommandCounter":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"configMqttCommandLastHit":{"nullable":true,"type":"string","format":"date-time"},"configMqttDataLimit":{"enum":["soft","hard","lock"],"nullable":true,"type":"string"},"configMqttDataCounter":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"configMqttDataLastHit":{"nullable":true,"type":"string","format":"date-time"},"configOpenvpnLimit":{"enum":["soft","hard","lock"],"nullable":true,"type":"string"},"configOpenvpnCounter":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"configOpenvpnLastHit":{"nullable":true,"type":"string","format":"date-time"}}},"vpnProtocol":{"enum":["udp","tcp"],"nullable":false,"type":"string"},"config":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"configFileServer":{"maxLength":4294967295,"minLength":0,"nullable":true,"type":"string"},"configPushedOn":{"nullable":true,"type":"string","format":"date-time"},"configFileReported":{"maxLength":4294967295,"minLength":0,"nullable":true,"type":"string"},"configFileReportedWlanKeyEnabled":{"nullable":false,"type":"boolean"},"configFileReportedCellularPasswordEnabled":{"nullable":false,"type":"boolean"},"configReportedOn":{"nullable":true,"type":"string","format":"date-time"},"differentConfigs":{"nullable":false,"type":"boolean"},"differentWanConfigs":{"nullable":false,"type":"boolean"},"stewardConfigFileServer":{"maxLength":4294967295,"minLength":0,"nullable":true,"type":"string"},"stewardConfigFileReported":{"maxLength":4294967295,"minLength":0,"nullable":true,"type":"string"},"stewardConfigReportedOn":{"nullable":true,"type":"string","format":"date-time"},"differentStewardConfigs":{"nullable":false,"type":"boolean"},"routerLan":{"nullable":false,"type":"object","properties":{"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"ipAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"netMask":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"network":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"dhcpServerEnabled":{"nullable":false,"type":"boolean"},"dhcpServerRangeFrom":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"dhcpServerRangeTo":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"gatewayLessRouting":{"nullable":false,"type":"boolean"},"forwardLanWan":{"enum":["neither","public","private","both"],"nullable":false,"type":"string"},"forwardLanWan2":{"enum":["neither","public","private","both"],"nullable":false,"type":"string"},"wlanEnable":{"nullable":true,"type":"boolean"},"wlanSsid":{"maxLength":32,"minLength":0,"nullable":true,"type":"string"},"wlanKey":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"wlanChannel":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"bacnetBbmd":{"type":"array","items":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}},"udpBroadcastRelayPort":{"type":"array","items":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}}}},"routerVpn":{"nullable":false,"type":"object","properties":{"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"sourceNatEnabled":{"nullable":false,"type":"boolean"}}},"routerWan":{"nullable":false,"type":"object","properties":{"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"multiwanPolicy":{"enum":["eth_cell_wifi","cell_eth_wifi","eth_wifi_cell","wifi_eth_cell","cell_wifi_eth","wifi_cell_eth"],"nullable":true,"type":"string"},"ipUseDhcp":{"nullable":true,"type":"boolean"},"ipAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"ipGateway":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"ipNetMask":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"dnsServers":{"type":"array","items":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}},"dnsRebindProtectionEnabled":{"nullable":true,"type":"boolean"},"cellularApn":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"cellularPincode":{"maxLength":8,"minLength":0,"nullable":true,"type":"string"},"cellularMtu":{"maximum":1500,"minimum":576,"nullable":true,"type":"integer","format":"int32"},"digitalInputMode":{"enum":["disable_vpn_high","disable_vpn_low","disable_wan_high","disable_wan_low"],"nullable":true,"type":"string"},"wanTrackInterval":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"wanTrackIps":{"type":"array","items":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}},"wlanTrackInterval":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"wlanTrackIps":{"type":"array","items":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}},"cellularTrackInterval":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"cellularTrackIps":{"type":"array","items":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}},"httpProxyAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"httpProxyPort":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"httpProxyAuthentication":{"enum":["none","basic","ntlm"],"nullable":true,"type":"string"},"httpProxyUsername":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"httpProxyIsSocks5":{"nullable":true,"type":"boolean"},"wlanSsid":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"wlanIpUseDhcp":{"nullable":true,"type":"boolean"},"wlanIpAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"wlanIpGateway":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"wlanIpNetMask":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"wlanDnsServers":{"type":"array","items":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}},"cellularUsername":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"}}},"routerDisplay":{"nullable":false,"type":"object","properties":{"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"lockEnabled":{"nullable":false,"type":"boolean"},"lockCode":{"maxLength":4,"minLength":4,"nullable":true,"pattern":"[0-9]+","type":"string"}}},"routerAdditionalSubnets":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"networkAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"networkMask":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"gatewayAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}},"routerPortForwards":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"interface":{"enum":["VPN","WAN","WAN2"],"nullable":false,"type":"string"},"targetIpAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"targetPort":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"externalPort":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}},"routerNtpServers":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"server":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}}},"demoDevice":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"expiresOn":{"nullable":false,"type":"string","format":"date-time"},"agentType":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"additionalSubnets":{"nullable":false,"type":"boolean"},"allowDataPublishing":{"nullable":false,"type":"boolean"},"allowDemoDevice":{"nullable":false,"type":"boolean"},"allowTemplating":{"nullable":false,"type":"boolean"},"allowReboot":{"nullable":false,"type":"boolean"},"configPush":{"nullable":false,"type":"boolean"},"configFileFormat":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"customServers":{"nullable":false,"type":"boolean"},"deviceIdFormat":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"httpProxyPort":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"latestFirmwareFile":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"code":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"notes":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"agentType":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"type":{"enum":["firmware"],"nullable":false,"type":"string"},"latest":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"offlineConfiguration":{"nullable":false,"type":"boolean"},"openvpnConfigMultiUse":{"nullable":false,"type":"boolean"},"purchasePrice":{"nullable":false,"type":"object","properties":{"gratis":{"nullable":false,"type":"boolean"}}},"router":{"nullable":false,"type":"boolean"},"stunnelSupport":{"nullable":false,"type":"boolean"},"wanPortForwardings":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"},"hasSecondWanPort":{"nullable":false,"type":"boolean"}}},"dmvServer":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}},"connectedUsers":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}},"loggingApp":{"nullable":false,"type":"object","properties":{"licence":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"type":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"usageType":{"enum":["advanced-user-management","agent-registration-profile","agent-templates","alarming","api-integrations","app-engine-level-1","app-engine-level-2","app-engine-level-3","asset-management","card-view","connection-monitoring","controlled-devices","custom-branding","custom-domain","custom-fields","custom-legal","custom-legal-legacy","custom-sso","edge-app-management","ixagent","landing-page","live-data","logging","m2m-cloud-cluster","main-pages","mobile-app","mqtt-device","object-storage","premium-branding","rdp","remote-access","reporting","request-access","rtsp","scim","session-recording","sla","ssh","subgroups","temporary-access","vpn-access-rule","vpn-usage"],"nullable":false,"type":"string"},"companyLimit":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"scope":{"enum":["agent","company"],"nullable":false,"type":"string"}}},"serialNumber":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"expiresOn":{"nullable":true,"type":"string","format":"date-time"},"activated":{"nullable":false,"type":"boolean"},"trial":{"nullable":false,"type":"boolean"},"value":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"locked":{"nullable":true,"type":"boolean"},"maxRetentionPolicy":{"maxLength":255,"minLength":2,"nullable":true,"type":"string"},"agent":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"deviceId":{"maxLength":128,"minLength":1,"nullable":false,"type":"string"},"type":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"location":{"nullable":false,"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"latitude":{"nullable":false,"type":"string"},"longitude":{"nullable":false,"type":"string"}}},"geoLocation":{"nullable":false,"type":"object","properties":{"latitude":{"nullable":false,"type":"string"},"longitude":{"nullable":false,"type":"string"},"country":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"city":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"custom":{"nullable":false,"type":"object"}}},"hasAgent":{"nullable":false,"type":"boolean"},"agentType":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"additionalSubnets":{"nullable":false,"type":"boolean"},"allowDataPublishing":{"nullable":false,"type":"boolean"},"allowDemoDevice":{"nullable":false,"type":"boolean"},"allowTemplating":{"nullable":false,"type":"boolean"},"allowReboot":{"nullable":false,"type":"boolean"},"configPush":{"nullable":false,"type":"boolean"},"configFileFormat":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"customServers":{"nullable":false,"type":"boolean"},"deviceIdFormat":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"httpProxyPort":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"latestFirmwareFile":{"nullable":false,"type":"object"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"offlineConfiguration":{"nullable":false,"type":"boolean"},"openvpnConfigMultiUse":{"nullable":false,"type":"boolean"},"purchasePrice":{"nullable":false,"type":"object"},"router":{"nullable":false,"type":"boolean"},"stunnelSupport":{"nullable":false,"type":"boolean"},"wanPortForwardings":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"},"hasSecondWanPort":{"nullable":false,"type":"boolean"}}},"bundle":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}},"enabled":{"nullable":false,"type":"boolean"}}},"valuesPerHour":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"alarmingApp":{"nullable":false,"type":"object","properties":{"licence":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"type":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"usageType":{"enum":["advanced-user-management","agent-registration-profile","agent-templates","alarming","api-integrations","app-engine-level-1","app-engine-level-2","app-engine-level-3","asset-management","card-view","connection-monitoring","controlled-devices","custom-branding","custom-domain","custom-fields","custom-legal","custom-legal-legacy","custom-sso","edge-app-management","ixagent","landing-page","live-data","logging","m2m-cloud-cluster","main-pages","mobile-app","mqtt-device","object-storage","premium-branding","rdp","remote-access","reporting","request-access","rtsp","scim","session-recording","sla","ssh","subgroups","temporary-access","vpn-access-rule","vpn-usage"],"nullable":false,"type":"string"},"companyLimit":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"scope":{"enum":["agent","company"],"nullable":false,"type":"string"}}},"serialNumber":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"expiresOn":{"nullable":true,"type":"string","format":"date-time"},"activated":{"nullable":false,"type":"boolean"},"trial":{"nullable":false,"type":"boolean"},"value":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"locked":{"nullable":true,"type":"boolean"},"maxRetentionPolicy":{"maxLength":255,"minLength":2,"nullable":true,"type":"string"},"agent":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"deviceId":{"maxLength":128,"minLength":1,"nullable":false,"type":"string"},"type":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"location":{"nullable":false,"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"latitude":{"nullable":false,"type":"string"},"longitude":{"nullable":false,"type":"string"}}},"geoLocation":{"nullable":false,"type":"object","properties":{"latitude":{"nullable":false,"type":"string"},"longitude":{"nullable":false,"type":"string"},"country":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"city":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"custom":{"nullable":false,"type":"object"}}},"hasAgent":{"nullable":false,"type":"boolean"},"agentType":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"additionalSubnets":{"nullable":false,"type":"boolean"},"allowDataPublishing":{"nullable":false,"type":"boolean"},"allowDemoDevice":{"nullable":false,"type":"boolean"},"allowTemplating":{"nullable":false,"type":"boolean"},"allowReboot":{"nullable":false,"type":"boolean"},"configPush":{"nullable":false,"type":"boolean"},"configFileFormat":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"customServers":{"nullable":false,"type":"boolean"},"deviceIdFormat":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"httpProxyPort":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"latestFirmwareFile":{"nullable":false,"type":"object"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"offlineConfiguration":{"nullable":false,"type":"boolean"},"openvpnConfigMultiUse":{"nullable":false,"type":"boolean"},"purchasePrice":{"nullable":false,"type":"object"},"router":{"nullable":false,"type":"boolean"},"stunnelSupport":{"nullable":false,"type":"boolean"},"wanPortForwardings":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"},"hasSecondWanPort":{"nullable":false,"type":"boolean"}}},"bundle":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}},"enabled":{"nullable":false,"type":"boolean"}}},"lanWanAccessRules":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"sourceIpAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"sourceMacAddress":{"maxLength":17,"minLength":17,"nullable":true,"pattern":"[0-9a-fA-F]{2}(:[0-9a-fA-F]{2}){5}","type":"string"},"destinationPort":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"destinationIpAddress":{"maxLength":19,"minLength":7,"nullable":true,"pattern":"\\d{1,3}(\\.\\d{1,3}){3}(\\/\\d{1,3})?","type":"string"},"protocol":{"enum":["all","tcp","udp","icmp","ah","ax.25","dccp","ddp","egp","eigrp","encap","esp","etherip","fc","ggp","gre","hmp","idpr-cmtp","idrp","igmp","igp","ipcomp","ipencap","ipip","ipv6","ipv6-frag","ipv6-icmp","ipv6-nonxt","ipv6-opts","ipv6-route","isis","iso-tp4","l2tp","ospf","pim","pup","rdp","rspf","rsvp","sctp","skip","st","vmtp","vrrp","xns-idp","xtp"],"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"}}}},"oneToOneNatRules":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"type":{"enum":["wan","wlan","vpn"],"nullable":false,"type":"string"},"virtualIpAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"destinationIpAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"protocol":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"port":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"sourceIpAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"}}}},"devices":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"ipAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"macAddress":{"maxLength":17,"minLength":17,"nullable":true,"pattern":"[0-9a-fA-F]{2}(:[0-9a-fA-F]{2}){5}","type":"string"},"customAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"dataSources":{"type":"array","items":{"nullable":false,"type":"object","properties":{"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"continueLoggingOnError":{"nullable":true,"type":"boolean"},"device":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"gracePeriod":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"slug":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"^[a-zA-Z0-9_\\[\\]-]+$","type":"string"},"disabled":{"nullable":false,"type":"boolean"},"protocol":{"oneOf":[{"type":"object","properties":{"publicId":{"enum":["custom"],"nullable":false,"type":"string"},"password":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}},"required":["publicId","password"]},{"type":"object","properties":{"publicId":{"enum":["modbus"],"nullable":false,"type":"string"},"slave":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"format":{"enum":["ABCD","BADC","CDAB","DCBA"],"nullable":true,"type":"string"},"readMode":{"enum":["single_value","consecutive_values","gapped_values"],"nullable":true,"type":"string"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["siemens-step7"],"nullable":false,"type":"string"},"pdu":{"maximum":2147483647,"minimum":-2147483648,"nullable":true,"type":"integer","format":"int32"},"rack":{"maximum":7,"nullable":true,"type":"integer","format":"int32"},"slot":{"maximum":31,"nullable":true,"type":"integer","format":"int32"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["opc-ua"],"nullable":false,"type":"string"},"authenticationType":{"enum":["anonymous","username","certificate"],"nullable":false,"type":"string"},"username":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"password":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"securityMode":{"enum":["sign","signandencrypt"],"nullable":true,"type":"string"},"securityPolicy":{"enum":["basic256sha256","aes128_sha256_rsaoaep","aes256_sha256_rsapss"],"nullable":true,"type":"string"}},"required":["publicId","authenticationType"]},{"type":"object","properties":{"publicId":{"enum":["ethernet-ip"],"nullable":false,"type":"string"},"cpu":{"enum":["compactlogix","micro800","micrologix","micrologix800","omron"],"nullable":false,"type":"string"},"rack":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"slot":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"}},"required":["publicId","cpu"]},{"type":"object","properties":{"publicId":{"enum":["host"],"nullable":false,"type":"string"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["bacnet-ip"],"nullable":false,"type":"string"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["mc-protocol"],"nullable":false,"type":"string"},"cpu":{"enum":["FX5U","IQR","L","Q","QNUCPU"],"nullable":true,"type":"string"},"protocol":{"enum":["TCP","UDP"],"nullable":true,"type":"string"},"networkNo":{"maximum":255,"nullable":true,"type":"integer","format":"int32"},"pcNo":{"maxLength":2,"minLength":1,"nullable":true,"pattern":"[A-Za-z0-9]+","type":"string"},"requestDestIoNr":{"maxLength":4,"minLength":1,"nullable":true,"pattern":"[A-Za-z0-9]+","type":"string"},"requestDestModuleStatNr":{"maximum":255,"nullable":true,"type":"integer","format":"int32"},"authenticationType":{"enum":["none","password"],"nullable":true,"type":"string"},"password":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"reconnectDelay":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"maxBlocks":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"maxPoints":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"}},"required":["publicId"]}]},"port":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"pullDelay":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"valuesPerHour":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"mqttTopic":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"mqttBrokerClient":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}}}}},"servers":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"type":{"enum":["http","rdp","rtsp","ssh","vnc","websocket"],"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"port":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"username":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"password":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"hasPassword":{"nullable":false,"type":"boolean"},"authDomain":{"maxLength":253,"minLength":4,"nullable":true,"pattern":".+(\\..[^.]+)","type":"string"},"landingPage":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"connectionQuality":{"enum":["low","normal","high"],"nullable":true,"type":"string"},"readOnly":{"nullable":true,"type":"boolean"},"vncRightClickOnTouchHold":{"nullable":false,"type":"boolean"},"vncEncoding":{"enum":["copyrect","corre","hextile","raw","rre","tight","ultra","ultrazip","zlib","zlibhex","zrle","zywrle"],"nullable":true,"type":"string"},"useSsl":{"nullable":false,"type":"boolean"},"visibleInMobileApp":{"nullable":false,"type":"boolean"},"visibleOnWeb":{"nullable":false,"type":"boolean"},"httpAuthenticationType":{"enum":["ntlm","basic","digest"],"nullable":true,"type":"string"},"recordSessions":{"nullable":true,"type":"boolean"},"audience":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"requireAccessApproval":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"device":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"serviceGroup":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"template":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"type":{"enum":["http","rdp","rtsp","ssh","vnc","websocket"],"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"port":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"username":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"password":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"hasPassword":{"nullable":false,"type":"boolean"},"authDomain":{"maxLength":253,"minLength":4,"nullable":true,"pattern":".+(\\..[^.]+)","type":"string"},"landingPage":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"connectionQuality":{"enum":["low","normal","high"],"nullable":true,"type":"string"},"readOnly":{"nullable":true,"type":"boolean"},"vncRightClickOnTouchHold":{"nullable":false,"type":"boolean"},"vncEncoding":{"enum":["copyrect","corre","hextile","raw","rre","tight","ultra","ultrazip","zlib","zlibhex","zrle","zywrle"],"nullable":true,"type":"string"},"useSsl":{"nullable":false,"type":"boolean"},"visibleInMobileApp":{"nullable":false,"type":"boolean"},"visibleOnWeb":{"nullable":false,"type":"boolean"},"httpAuthenticationType":{"enum":["ntlm","basic","digest"],"nullable":true,"type":"string"},"recordSessions":{"nullable":true,"type":"boolean"},"audience":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"requireAccessApproval":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"}}}}}},"dataSources":{"type":"array","items":{"nullable":false,"type":"object","properties":{"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"continueLoggingOnError":{"nullable":true,"type":"boolean"},"device":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"gracePeriod":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"slug":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"^[a-zA-Z0-9_\\[\\]-]+$","type":"string"},"disabled":{"nullable":false,"type":"boolean"},"protocol":{"oneOf":[{"type":"object","properties":{"publicId":{"enum":["custom"],"nullable":false,"type":"string"},"password":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}},"required":["publicId","password"]},{"type":"object","properties":{"publicId":{"enum":["modbus"],"nullable":false,"type":"string"},"slave":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"format":{"enum":["ABCD","BADC","CDAB","DCBA"],"nullable":true,"type":"string"},"readMode":{"enum":["single_value","consecutive_values","gapped_values"],"nullable":true,"type":"string"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["siemens-step7"],"nullable":false,"type":"string"},"pdu":{"maximum":2147483647,"minimum":-2147483648,"nullable":true,"type":"integer","format":"int32"},"rack":{"maximum":7,"nullable":true,"type":"integer","format":"int32"},"slot":{"maximum":31,"nullable":true,"type":"integer","format":"int32"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["opc-ua"],"nullable":false,"type":"string"},"authenticationType":{"enum":["anonymous","username","certificate"],"nullable":false,"type":"string"},"username":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"password":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"securityMode":{"enum":["sign","signandencrypt"],"nullable":true,"type":"string"},"securityPolicy":{"enum":["basic256sha256","aes128_sha256_rsaoaep","aes256_sha256_rsapss"],"nullable":true,"type":"string"}},"required":["publicId","authenticationType"]},{"type":"object","properties":{"publicId":{"enum":["ethernet-ip"],"nullable":false,"type":"string"},"cpu":{"enum":["compactlogix","micro800","micrologix","micrologix800","omron"],"nullable":false,"type":"string"},"rack":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"slot":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"}},"required":["publicId","cpu"]},{"type":"object","properties":{"publicId":{"enum":["host"],"nullable":false,"type":"string"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["bacnet-ip"],"nullable":false,"type":"string"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["mc-protocol"],"nullable":false,"type":"string"},"cpu":{"enum":["FX5U","IQR","L","Q","QNUCPU"],"nullable":true,"type":"string"},"protocol":{"enum":["TCP","UDP"],"nullable":true,"type":"string"},"networkNo":{"maximum":255,"nullable":true,"type":"integer","format":"int32"},"pcNo":{"maxLength":2,"minLength":1,"nullable":true,"pattern":"[A-Za-z0-9]+","type":"string"},"requestDestIoNr":{"maxLength":4,"minLength":1,"nullable":true,"pattern":"[A-Za-z0-9]+","type":"string"},"requestDestModuleStatNr":{"maximum":255,"nullable":true,"type":"integer","format":"int32"},"authenticationType":{"enum":["none","password"],"nullable":true,"type":"string"},"password":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"reconnectDelay":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"maxBlocks":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"maxPoints":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"}},"required":["publicId"]}]},"port":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"pullDelay":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"valuesPerHour":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"mqttTopic":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"mqttBrokerClient":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}},"pageLinks":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"asset":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"menuItem":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"page":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"audience":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"custom":{"nullable":false,"type":"object"},"default":{"nullable":false,"type":"boolean"},"type":{"enum":["alarm","page","service"],"nullable":true,"type":"string"}}},"group":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"asset":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"menuItem":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"custom":{"nullable":false,"type":"object"}}}},"scheduledAccessRequests":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"user":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"approver":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"approverCompany":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"vpn":{"nullable":false,"type":"boolean"},"servers":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}},"start":{"nullable":false,"type":"string","format":"date-time"},"end":{"nullable":false,"type":"string","format":"date-time"},"status":{"enum":["approved","pending","rejected","revoked"],"nullable":false,"type":"string"},"reason":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"createdOn":{"nullable":false,"type":"string","format":"date-time"},"updatedOn":{"nullable":true,"type":"string","format":"date-time"},"allowedApprovers":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}},"reviewExpiresOn":{"nullable":true,"type":"string","format":"date-time"}}}},"assets":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}},"registrationProfile":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":24,"minLength":24,"nullable":false,"pattern":"(\\d{4}-){4}\\d{4}","type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"agentActivationName":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"}}},"vpnLocked":{"nullable":false,"type":"boolean"},"webAccessLocked":{"nullable":false,"type":"boolean"},"appliedTemplateVersion":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"createdOn":{"nullable":false,"type":"string","format":"date-time"},"createdBy":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"company":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"description":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"agentTemplate":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"number":{"maxLength":64,"minLength":1,"nullable":false,"type":"string"}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"patch":{"tags":["Agent"],"summary":"Agent","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"location":{"nullable":true,"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"latitude":{"nullable":false,"type":"string"},"longitude":{"nullable":false,"type":"string"}}},"timeZone":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"custom":{"nullable":false,"type":"object"},"description":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"useStunnel":{"nullable":false,"type":"boolean"},"replaceMacAddress":{"maxLength":17,"minLength":0,"nullable":true,"pattern":"[0-9a-fA-F]{2}(:[0-9a-fA-F]{2}){5}","type":"string"},"reRegistration":{"nullable":false,"type":"boolean"},"fixedVpnAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"preferLocationOverGeoip":{"nullable":false,"type":"boolean"},"card":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"vpnAudience":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"vpnRequireAccessApproval":{"nullable":false,"type":"boolean"},"vpnVisibleInMobileApp":{"nullable":false,"type":"boolean"},"vpnVisibleOnWeb":{"nullable":false,"type":"boolean"},"dataAudience":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"rateLimiting":{"nullable":false,"type":"object","properties":{"configMqttCommandReset":{"nullable":true,"type":"boolean"},"configMqttDataReset":{"nullable":true,"type":"boolean"},"configOpenvpnReset":{"nullable":true,"type":"boolean"}}},"vpnProtocol":{"enum":["udp","tcp"],"nullable":false,"type":"string"}}}}}},"security":[{"bearerToken":[]}]},"delete":{"tags":["Agent"],"summary":"Agent","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/agents/{agentId}/access-requests/{publicId}":{"get":{"tags":["AgentAccessRequest"],"summary":"AgentAccessRequest","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"user":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"approver":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"approverCompany":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"vpn":{"nullable":false,"type":"boolean"},"servers":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}},"start":{"nullable":false,"type":"string","format":"date-time"},"end":{"nullable":false,"type":"string","format":"date-time"},"status":{"enum":["approved","pending","rejected","revoked"],"nullable":false,"type":"string"},"reason":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"createdOn":{"nullable":false,"type":"string","format":"date-time"},"updatedOn":{"nullable":true,"type":"string","format":"date-time"},"allowedApprovers":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}},"reviewExpiresOn":{"nullable":true,"type":"string","format":"date-time"}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/agents/access-requests/approve":{"post":{"tags":["AgentAccessRequestApprove"],"summary":"AgentAccessRequestApprove","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"deviceName":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"serviceNames":{"type":"array","items":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}},"vpn":{"nullable":false,"type":"boolean"},"emailAddress":{"maxLength":254,"minLength":6,"nullable":false,"pattern":"^(?=.{1,254}$)(?=.{1,64}@)[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+(?:\\.[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+)*@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$","type":"string"}},"required":["deviceName","serviceNames","vpn","emailAddress"]}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"}]}},"/agents/{agentId}/approvers":{"get":{"tags":["AgentAccessRequestApproverList"],"summary":"AgentAccessRequestApproverList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"user":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"company":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/agents/{agentId}/access-requests/approve/{publicId}":{"post":{"tags":["AgentAccessRequestAuthenticatedApprove"],"summary":"AgentAccessRequestAuthenticatedApprove","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"deviceName":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"serviceNames":{"type":"array","items":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}},"vpn":{"nullable":false,"type":"boolean"},"emailAddress":{"maxLength":254,"minLength":6,"nullable":false,"pattern":"^(?=.{1,254}$)(?=.{1,64}@)[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+(?:\\.[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+)*@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$","type":"string"}},"required":["deviceName","serviceNames","vpn","emailAddress"]}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/agents/{agentId}/access-requests/reject/{publicId}":{"post":{"tags":["AgentAccessRequestAuthenticatedReject"],"summary":"AgentAccessRequestAuthenticatedReject","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"deviceName":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"serviceNames":{"type":"array","items":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}},"vpn":{"nullable":false,"type":"boolean"},"emailAddress":{"maxLength":254,"minLength":6,"nullable":false,"pattern":"^(?=.{1,254}$)(?=.{1,64}@)[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+(?:\\.[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+)*@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$","type":"string"}},"required":["deviceName","serviceNames","vpn","emailAddress"]}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/agents/access-requests":{"get":{"tags":["AgentAccessRequestInfo"],"summary":"AgentAccessRequestInfo","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"deviceName":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"serviceNames":{"type":"array","items":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}},"vpn":{"nullable":false,"type":"boolean"},"emailAddress":{"maxLength":254,"minLength":6,"nullable":false,"pattern":"^(?=.{1,254}$)(?=.{1,64}@)[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+(?:\\.[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+)*@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$","type":"string"}},"required":["deviceName","serviceNames","vpn","emailAddress"]}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"}]}},"/agents/{agentId}/access-requests":{"get":{"tags":["AgentAccessRequestList"],"summary":"AgentAccessRequestList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"user":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"approver":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"approverCompany":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"vpn":{"nullable":false,"type":"boolean"},"servers":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}},"start":{"nullable":false,"type":"string","format":"date-time"},"end":{"nullable":false,"type":"string","format":"date-time"},"status":{"enum":["approved","pending","rejected","revoked"],"nullable":false,"type":"string"},"reason":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"createdOn":{"nullable":false,"type":"string","format":"date-time"},"updatedOn":{"nullable":true,"type":"string","format":"date-time"},"allowedApprovers":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}},"reviewExpiresOn":{"nullable":true,"type":"string","format":"date-time"}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"post":{"tags":["AgentAccessRequestList"],"summary":"AgentAccessRequestList","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"vpn":{"nullable":false,"type":"boolean"},"servers":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}},"start":{"nullable":false,"type":"string","format":"date-time"},"end":{"nullable":false,"type":"string","format":"date-time"},"reason":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"allowedApprovers":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}},"required":["servers","start","end","reason","allowedApprovers"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/agents/access-requests/reject":{"post":{"tags":["AgentAccessRequestReject"],"summary":"AgentAccessRequestReject","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"deviceName":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"serviceNames":{"type":"array","items":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}},"vpn":{"nullable":false,"type":"boolean"},"emailAddress":{"maxLength":254,"minLength":6,"nullable":false,"pattern":"^(?=.{1,254}$)(?=.{1,64}@)[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+(?:\\.[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+)*@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$","type":"string"}},"required":["deviceName","serviceNames","vpn","emailAddress"]}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"}]}},"/agents/{agentId}/access-requests/resend/{publicId}/resend":{"post":{"tags":["AgentAccessRequestResend"],"summary":"AgentAccessRequestResend","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/agents/{agentId}/access-requests/resend":{"post":{"tags":["AgentAccessRequestResendList"],"summary":"AgentAccessRequestResendList","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/agents/{publicId}/app/alarming":{"delete":{"tags":["AgentAppAlarming"],"summary":"AgentAppAlarming","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/agents/app/alarming":{"delete":{"tags":["AgentAppAlarmingList"],"summary":"AgentAppAlarmingList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/agents/app/alarming/activate":{"post":{"tags":["AgentAppAlarmingListActivate"],"summary":"AgentAppAlarmingListActivate","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"couponCode":{"maxLength":15,"minLength":15,"nullable":false,"pattern":"([1-9]{3}|[B-DF-HJ-NP-TV-Z]{3})(-([1-9]{3}|[B-DF-HJ-NP-TV-Z]{3})){3}","type":"string"},"licence":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"trial":{"nullable":false,"type":"boolean"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/agents/{publicId}/app/logging":{"delete":{"tags":["AgentAppLogging"],"summary":"AgentAppLogging","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/agents/app/logging":{"delete":{"tags":["AgentAppLoggingList"],"summary":"AgentAppLoggingList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/agents/app/logging/activate":{"post":{"tags":["AgentAppLoggingListActivate"],"summary":"AgentAppLoggingListActivate","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"couponCode":{"maxLength":15,"minLength":15,"nullable":false,"pattern":"([1-9]{3}|[B-DF-HJ-NP-TV-Z]{3})(-([1-9]{3}|[B-DF-HJ-NP-TV-Z]{3})){3}","type":"string"},"licence":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"trial":{"nullable":false,"type":"boolean"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/agents/{agentId}/audit-logs":{"get":{"tags":["AgentAuditLogList"],"summary":"AgentAuditLogList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":24,"minLength":24,"nullable":false,"type":"string"},"action":{"enum":["CREATE","UPDATE","DELETE","TRIGGER"],"nullable":false,"type":"string"},"topic":{"nullable":false,"type":"object","properties":{"company":{"maxLength":24,"minLength":24,"nullable":false,"type":"string"},"user":{"maxLength":12,"minLength":12,"nullable":true,"type":"string"},"agent":{"maxLength":12,"minLength":12,"nullable":true,"type":"string"},"asset":{"maxLength":12,"minLength":12,"nullable":true,"type":"string"}}},"time":{"nullable":false,"type":"string","format":"date-time"},"request":{"nullable":false,"type":"object","properties":{"ipAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"fromName":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"geoLocation":{"nullable":true,"type":"object","properties":{"latitude":{"nullable":false,"type":"string"},"longitude":{"nullable":false,"type":"string"},"country":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"city":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}},"actor":{"nullable":false,"type":"object","properties":{"type":{"enum":["agent","support","client","webshopintegration","scim-provisioning"],"nullable":false,"type":"string"},"resource":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":24,"minLength":2,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"type":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}},"application":{"nullable":true,"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"target":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"before":{"nullable":true},"after":{"nullable":true}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/agents/{agentId}/backend-component-function-call":{"post":{"tags":["AgentBackendComponentFunctionCall"],"summary":"AgentBackendComponentFunctionCall","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"value":{"nullable":false}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"template":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"arguments":{"nullable":true}},"required":["template","name"]}}}},"security":[{"bearerToken":[]}]}},"/agents/{publicId}/configuration/import":{"put":{"tags":["AgentConfigurationImport"],"summary":"AgentConfigurationImport","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/agents/{agentId}/control-key":{"get":{"tags":["AgentControlKey"],"summary":"AgentControlKey","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"controlKey":{"maxLength":11,"minLength":11,"nullable":true,"pattern":"[B-DF-HJ-NP-TV-Z]{3}-[1-9]{3}-[B-DF-HJ-NP-TV-Z]{3}","type":"string"},"controlKeyGeneratedOn":{"nullable":true,"type":"string","format":"date-time"}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"post":{"tags":["AgentControlKey"],"summary":"AgentControlKey","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"controlKey":{"maxLength":11,"minLength":11,"nullable":true,"pattern":"[B-DF-HJ-NP-TV-Z]{3}-[1-9]{3}-[B-DF-HJ-NP-TV-Z]{3}","type":"string"},"controlKeyGeneratedOn":{"nullable":true,"type":"string","format":"date-time"}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"delete":{"tags":["AgentControlKey"],"summary":"AgentControlKey","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/agents/{agentId}/data-alarms/{publicId}":{"get":{"tags":["AgentDataAlarm"],"summary":"AgentDataAlarm","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"device":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"source":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"audience":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"type":{"enum":["unary","boolean","error_bits","threshold","rate_of_change","bit_pattern"],"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"autoAcknowledge":{"nullable":false,"type":"boolean"},"booleanNormalValue":{"nullable":false,"type":"boolean"},"formula":{"maxLength":255,"minLength":2,"nullable":false,"type":"string"},"offDelay":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"offResetDelay":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"onDelay":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"onResetDelay":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"operatorInstructionRtn":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"outOfService":{"nullable":false,"type":"boolean"},"severity":{"enum":["low","medium","high"],"nullable":false,"type":"string"}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"patch":{"tags":["AgentDataAlarm"],"summary":"AgentDataAlarm","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"enum":["unary","boolean","error_bits","threshold","rate_of_change","bit_pattern"],"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"formula":{"maxLength":255,"minLength":2,"nullable":false,"type":"string"},"audience":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"autoAcknowledge":{"nullable":false,"type":"boolean"},"booleanNormalValue":{"nullable":false,"type":"boolean"},"offDelay":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"offResetDelay":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"onDelay":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"onResetDelay":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"operatorInstructionRtn":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"outOfService":{"nullable":false,"type":"boolean"},"severity":{"enum":["low","medium","high"],"nullable":false,"type":"string"}}}}}},"security":[{"bearerToken":[]}]},"delete":{"tags":["AgentDataAlarm"],"summary":"AgentDataAlarm","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/agents/{agentId}/data-alarms":{"get":{"tags":["AgentDataAlarmList"],"summary":"AgentDataAlarmList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"device":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"source":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"audience":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"type":{"enum":["unary","boolean","error_bits","threshold","rate_of_change","bit_pattern"],"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"autoAcknowledge":{"nullable":false,"type":"boolean"},"booleanNormalValue":{"nullable":false,"type":"boolean"},"formula":{"maxLength":255,"minLength":2,"nullable":false,"type":"string"},"offDelay":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"offResetDelay":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"onDelay":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"onResetDelay":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"operatorInstructionRtn":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"outOfService":{"nullable":false,"type":"boolean"},"severity":{"enum":["low","medium","high"],"nullable":false,"type":"string"}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"post":{"tags":["AgentDataAlarmList"],"summary":"AgentDataAlarmList","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"source":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"type":{"enum":["unary","boolean","error_bits","threshold","rate_of_change","bit_pattern"],"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"formula":{"maxLength":255,"minLength":2,"nullable":false,"type":"string"},"audience":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"autoAcknowledge":{"nullable":false,"type":"boolean"},"booleanNormalValue":{"nullable":false,"type":"boolean"},"offDelay":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"offResetDelay":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"onDelay":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"onResetDelay":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"operatorInstructionRtn":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"outOfService":{"nullable":false,"type":"boolean"},"severity":{"enum":["low","medium","high"],"nullable":false,"type":"string"}},"required":["type","name","formula","audience"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"patch":{"tags":["AgentDataAlarmList"],"summary":"AgentDataAlarmList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"type":{"enum":["unary","boolean","error_bits","threshold","rate_of_change","bit_pattern"],"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"formula":{"maxLength":255,"minLength":2,"nullable":false,"type":"string"},"audience":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"autoAcknowledge":{"nullable":false,"type":"boolean"},"booleanNormalValue":{"nullable":false,"type":"boolean"},"offDelay":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"offResetDelay":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"onDelay":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"onResetDelay":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"operatorInstructionRtn":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"outOfService":{"nullable":false,"type":"boolean"},"severity":{"enum":["low","medium","high"],"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"delete":{"tags":["AgentDataAlarmList"],"summary":"AgentDataAlarmList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/agents/{agentId}/alarm-occurrences/{publicId}":{"get":{"tags":["AgentDataAlarmOccurrence"],"summary":"AgentDataAlarmOccurrence","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"alarm":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"device":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"source":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"audience":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"type":{"enum":["unary","boolean","error_bits","threshold","rate_of_change","bit_pattern"],"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"autoAcknowledge":{"nullable":false,"type":"boolean"},"booleanNormalValue":{"nullable":false,"type":"boolean"},"formula":{"maxLength":255,"minLength":2,"nullable":false,"type":"string"},"offDelay":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"offResetDelay":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"onDelay":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"onResetDelay":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"operatorInstructionRtn":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"outOfService":{"nullable":false,"type":"boolean"},"severity":{"enum":["low","medium","high"],"nullable":false,"type":"string"}}},"acknowledged":{"nullable":false,"type":"boolean"},"acknowledgedBy":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"acknowledgedOn":{"nullable":true,"type":"string","format":"date-time"},"comment":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"occurredOn":{"nullable":false,"type":"string","format":"date-time"},"rateLimitTill":{"nullable":true,"type":"string","format":"date-time"},"rtnOn":{"nullable":true,"type":"string","format":"date-time"},"silenced":{"nullable":false,"type":"boolean"},"stillActiveOn":{"nullable":true,"type":"string","format":"date-time"}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/filtersParameter"},{"$ref":"#/components/parameters/fieldsParameter"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"patch":{"tags":["AgentDataAlarmOccurrence"],"summary":"AgentDataAlarmOccurrence","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"acknowledged":{"nullable":false,"type":"boolean"},"comment":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"silenced":{"nullable":false,"type":"boolean"}}}}}},"security":[{"bearerToken":[]}]}},"/agents/{agentId}/latest-alarm-occurrences":{"get":{"tags":["AgentDataAlarmOccurrenceLatestList"],"summary":"AgentDataAlarmOccurrenceLatestList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"alarm":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"device":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"source":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"audience":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"type":{"enum":["unary","boolean","error_bits","threshold","rate_of_change","bit_pattern"],"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"autoAcknowledge":{"nullable":false,"type":"boolean"},"booleanNormalValue":{"nullable":false,"type":"boolean"},"formula":{"maxLength":255,"minLength":2,"nullable":false,"type":"string"},"offDelay":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"offResetDelay":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"onDelay":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"onResetDelay":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"operatorInstructionRtn":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"outOfService":{"nullable":false,"type":"boolean"},"severity":{"enum":["low","medium","high"],"nullable":false,"type":"string"}}},"acknowledged":{"nullable":false,"type":"boolean"},"acknowledgedBy":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"acknowledgedOn":{"nullable":true,"type":"string","format":"date-time"},"comment":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"occurredOn":{"nullable":false,"type":"string","format":"date-time"},"rateLimitTill":{"nullable":true,"type":"string","format":"date-time"},"rtnOn":{"nullable":true,"type":"string","format":"date-time"},"silenced":{"nullable":false,"type":"boolean"},"stillActiveOn":{"nullable":true,"type":"string","format":"date-time"}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/filtersParameter"},{"$ref":"#/components/parameters/fieldsParameter"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/agents/{agentId}/alarm-occurrences":{"get":{"tags":["AgentDataAlarmOccurrenceList"],"summary":"AgentDataAlarmOccurrenceList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"alarm":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"device":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"source":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"audience":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"type":{"enum":["unary","boolean","error_bits","threshold","rate_of_change","bit_pattern"],"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"autoAcknowledge":{"nullable":false,"type":"boolean"},"booleanNormalValue":{"nullable":false,"type":"boolean"},"formula":{"maxLength":255,"minLength":2,"nullable":false,"type":"string"},"offDelay":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"offResetDelay":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"onDelay":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"onResetDelay":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"operatorInstructionRtn":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"outOfService":{"nullable":false,"type":"boolean"},"severity":{"enum":["low","medium","high"],"nullable":false,"type":"string"}}},"acknowledged":{"nullable":false,"type":"boolean"},"acknowledgedBy":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"acknowledgedOn":{"nullable":true,"type":"string","format":"date-time"},"comment":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"occurredOn":{"nullable":false,"type":"string","format":"date-time"},"rateLimitTill":{"nullable":true,"type":"string","format":"date-time"},"rtnOn":{"nullable":true,"type":"string","format":"date-time"},"silenced":{"nullable":false,"type":"boolean"},"stillActiveOn":{"nullable":true,"type":"string","format":"date-time"}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/filtersParameter"},{"$ref":"#/components/parameters/fieldsParameter"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"patch":{"tags":["AgentDataAlarmOccurrenceList"],"summary":"AgentDataAlarmOccurrenceList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"acknowledged":{"nullable":false,"type":"boolean"},"comment":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"silenced":{"nullable":false,"type":"boolean"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/agents/{agentId}/data-conditions/{publicId}":{"get":{"tags":["AgentDataCondition"],"summary":"AgentDataCondition","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"device":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"source":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"formula":{"maxLength":255,"minLength":2,"nullable":false,"type":"string"}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"patch":{"tags":["AgentDataCondition"],"summary":"AgentDataCondition","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"formula":{"maxLength":255,"minLength":2,"nullable":false,"type":"string"}}}}}},"security":[{"bearerToken":[]}]},"delete":{"tags":["AgentDataCondition"],"summary":"AgentDataCondition","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/agents/{agentId}/data-conditions":{"get":{"tags":["AgentDataConditionList"],"summary":"AgentDataConditionList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"device":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"source":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"formula":{"maxLength":255,"minLength":2,"nullable":false,"type":"string"}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"post":{"tags":["AgentDataConditionList"],"summary":"AgentDataConditionList","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"source":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"formula":{"maxLength":255,"minLength":2,"nullable":false,"type":"string"}},"required":["source","name","formula"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"patch":{"tags":["AgentDataConditionList"],"summary":"AgentDataConditionList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"formula":{"maxLength":255,"minLength":2,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"delete":{"tags":["AgentDataConditionList"],"summary":"AgentDataConditionList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/agents/{agentId}/data-protocols":{"get":{"tags":["AgentDataProtocolList"],"summary":"AgentDataProtocolList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"defaultPort":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/agents/{agentId}/data-sources/{publicId}":{"get":{"tags":["AgentDataSource"],"summary":"AgentDataSource","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"continueLoggingOnError":{"nullable":true,"type":"boolean"},"device":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"gracePeriod":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"slug":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"^[a-zA-Z0-9_\\[\\]-]+$","type":"string"},"disabled":{"nullable":false,"type":"boolean"},"protocol":{"oneOf":[{"type":"object","properties":{"publicId":{"enum":["custom"],"nullable":false,"type":"string"},"password":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}},"required":["publicId","password"]},{"type":"object","properties":{"publicId":{"enum":["modbus"],"nullable":false,"type":"string"},"slave":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"format":{"enum":["ABCD","BADC","CDAB","DCBA"],"nullable":true,"type":"string"},"readMode":{"enum":["single_value","consecutive_values","gapped_values"],"nullable":true,"type":"string"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["siemens-step7"],"nullable":false,"type":"string"},"pdu":{"maximum":2147483647,"minimum":-2147483648,"nullable":true,"type":"integer","format":"int32"},"rack":{"maximum":7,"nullable":true,"type":"integer","format":"int32"},"slot":{"maximum":31,"nullable":true,"type":"integer","format":"int32"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["opc-ua"],"nullable":false,"type":"string"},"authenticationType":{"enum":["anonymous","username","certificate"],"nullable":false,"type":"string"},"username":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"password":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"securityMode":{"enum":["sign","signandencrypt"],"nullable":true,"type":"string"},"securityPolicy":{"enum":["basic256sha256","aes128_sha256_rsaoaep","aes256_sha256_rsapss"],"nullable":true,"type":"string"}},"required":["publicId","authenticationType"]},{"type":"object","properties":{"publicId":{"enum":["ethernet-ip"],"nullable":false,"type":"string"},"cpu":{"enum":["compactlogix","micro800","micrologix","micrologix800","omron"],"nullable":false,"type":"string"},"rack":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"slot":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"}},"required":["publicId","cpu"]},{"type":"object","properties":{"publicId":{"enum":["host"],"nullable":false,"type":"string"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["bacnet-ip"],"nullable":false,"type":"string"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["mc-protocol"],"nullable":false,"type":"string"},"cpu":{"enum":["FX5U","IQR","L","Q","QNUCPU"],"nullable":true,"type":"string"},"protocol":{"enum":["TCP","UDP"],"nullable":true,"type":"string"},"networkNo":{"maximum":255,"nullable":true,"type":"integer","format":"int32"},"pcNo":{"maxLength":2,"minLength":1,"nullable":true,"pattern":"[A-Za-z0-9]+","type":"string"},"requestDestIoNr":{"maxLength":4,"minLength":1,"nullable":true,"pattern":"[A-Za-z0-9]+","type":"string"},"requestDestModuleStatNr":{"maximum":255,"nullable":true,"type":"integer","format":"int32"},"authenticationType":{"enum":["none","password"],"nullable":true,"type":"string"},"password":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"reconnectDelay":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"maxBlocks":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"maxPoints":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"}},"required":["publicId"]}]},"port":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"pullDelay":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"valuesPerHour":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"mqttTopic":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"mqttBrokerClient":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"patch":{"tags":["AgentDataSource"],"summary":"AgentDataSource","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"continueLoggingOnError":{"nullable":true,"type":"boolean"},"device":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"gracePeriod":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"slug":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"^[a-zA-Z0-9_\\[\\]-]+$","type":"string"},"disabled":{"nullable":false,"type":"boolean"},"protocol":{"oneOf":[{"type":"object","properties":{"publicId":{"enum":["custom"],"nullable":false,"type":"string"},"password":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}},"required":["publicId","password"]},{"type":"object","properties":{"publicId":{"enum":["modbus"],"nullable":false,"type":"string"},"slave":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"format":{"enum":["ABCD","BADC","CDAB","DCBA"],"nullable":true,"type":"string"},"readMode":{"enum":["single_value","consecutive_values","gapped_values"],"nullable":true,"type":"string"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["siemens-step7"],"nullable":false,"type":"string"},"pdu":{"maximum":2147483647,"minimum":-2147483648,"nullable":true,"type":"integer","format":"int32"},"rack":{"maximum":7,"nullable":true,"type":"integer","format":"int32"},"slot":{"maximum":31,"nullable":true,"type":"integer","format":"int32"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["opc-ua"],"nullable":false,"type":"string"},"authenticationType":{"enum":["anonymous","username","certificate"],"nullable":false,"type":"string"},"username":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"password":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"securityMode":{"enum":["sign","signandencrypt"],"nullable":true,"type":"string"},"securityPolicy":{"enum":["basic256sha256","aes128_sha256_rsaoaep","aes256_sha256_rsapss"],"nullable":true,"type":"string"}},"required":["publicId","authenticationType"]},{"type":"object","properties":{"publicId":{"enum":["ethernet-ip"],"nullable":false,"type":"string"},"cpu":{"enum":["compactlogix","micro800","micrologix","micrologix800","omron"],"nullable":false,"type":"string"},"rack":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"slot":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"}},"required":["publicId","cpu"]},{"type":"object","properties":{"publicId":{"enum":["host"],"nullable":false,"type":"string"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["bacnet-ip"],"nullable":false,"type":"string"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["mc-protocol"],"nullable":false,"type":"string"},"cpu":{"enum":["FX5U","IQR","L","Q","QNUCPU"],"nullable":true,"type":"string"},"protocol":{"enum":["TCP","UDP"],"nullable":true,"type":"string"},"networkNo":{"maximum":255,"nullable":true,"type":"integer","format":"int32"},"pcNo":{"maxLength":2,"minLength":1,"nullable":true,"pattern":"[A-Za-z0-9]+","type":"string"},"requestDestIoNr":{"maxLength":4,"minLength":1,"nullable":true,"pattern":"[A-Za-z0-9]+","type":"string"},"requestDestModuleStatNr":{"maximum":255,"nullable":true,"type":"integer","format":"int32"},"authenticationType":{"enum":["none","password"],"nullable":true,"type":"string"},"password":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"reconnectDelay":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"maxBlocks":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"maxPoints":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"}},"required":["publicId"]}]},"port":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"pullDelay":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"mqttTopic":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"mqttBrokerClient":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}},"required":["protocol"]}}}},"security":[{"bearerToken":[]}]},"delete":{"tags":["AgentDataSource"],"summary":"AgentDataSource","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/agents/{agentId}/data-sources":{"get":{"tags":["AgentDataSourceList"],"summary":"AgentDataSourceList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"continueLoggingOnError":{"nullable":true,"type":"boolean"},"device":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"gracePeriod":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"slug":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"^[a-zA-Z0-9_\\[\\]-]+$","type":"string"},"disabled":{"nullable":false,"type":"boolean"},"protocol":{"oneOf":[{"type":"object","properties":{"publicId":{"enum":["custom"],"nullable":false,"type":"string"},"password":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}},"required":["publicId","password"]},{"type":"object","properties":{"publicId":{"enum":["modbus"],"nullable":false,"type":"string"},"slave":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"format":{"enum":["ABCD","BADC","CDAB","DCBA"],"nullable":true,"type":"string"},"readMode":{"enum":["single_value","consecutive_values","gapped_values"],"nullable":true,"type":"string"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["siemens-step7"],"nullable":false,"type":"string"},"pdu":{"maximum":2147483647,"minimum":-2147483648,"nullable":true,"type":"integer","format":"int32"},"rack":{"maximum":7,"nullable":true,"type":"integer","format":"int32"},"slot":{"maximum":31,"nullable":true,"type":"integer","format":"int32"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["opc-ua"],"nullable":false,"type":"string"},"authenticationType":{"enum":["anonymous","username","certificate"],"nullable":false,"type":"string"},"username":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"password":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"securityMode":{"enum":["sign","signandencrypt"],"nullable":true,"type":"string"},"securityPolicy":{"enum":["basic256sha256","aes128_sha256_rsaoaep","aes256_sha256_rsapss"],"nullable":true,"type":"string"}},"required":["publicId","authenticationType"]},{"type":"object","properties":{"publicId":{"enum":["ethernet-ip"],"nullable":false,"type":"string"},"cpu":{"enum":["compactlogix","micro800","micrologix","micrologix800","omron"],"nullable":false,"type":"string"},"rack":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"slot":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"}},"required":["publicId","cpu"]},{"type":"object","properties":{"publicId":{"enum":["host"],"nullable":false,"type":"string"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["bacnet-ip"],"nullable":false,"type":"string"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["mc-protocol"],"nullable":false,"type":"string"},"cpu":{"enum":["FX5U","IQR","L","Q","QNUCPU"],"nullable":true,"type":"string"},"protocol":{"enum":["TCP","UDP"],"nullable":true,"type":"string"},"networkNo":{"maximum":255,"nullable":true,"type":"integer","format":"int32"},"pcNo":{"maxLength":2,"minLength":1,"nullable":true,"pattern":"[A-Za-z0-9]+","type":"string"},"requestDestIoNr":{"maxLength":4,"minLength":1,"nullable":true,"pattern":"[A-Za-z0-9]+","type":"string"},"requestDestModuleStatNr":{"maximum":255,"nullable":true,"type":"integer","format":"int32"},"authenticationType":{"enum":["none","password"],"nullable":true,"type":"string"},"password":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"reconnectDelay":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"maxBlocks":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"maxPoints":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"}},"required":["publicId"]}]},"port":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"pullDelay":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"valuesPerHour":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"mqttTopic":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"mqttBrokerClient":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"post":{"tags":["AgentDataSourceList"],"summary":"AgentDataSourceList","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"device":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"continueLoggingOnError":{"nullable":true,"type":"boolean"},"gracePeriod":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"slug":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"^[a-zA-Z0-9_\\[\\]-]+$","type":"string"},"disabled":{"nullable":false,"type":"boolean"},"protocol":{"oneOf":[{"type":"object","properties":{"publicId":{"enum":["custom"],"nullable":false,"type":"string"},"password":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}},"required":["publicId","password"]},{"type":"object","properties":{"publicId":{"enum":["modbus"],"nullable":false,"type":"string"},"slave":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"format":{"enum":["ABCD","BADC","CDAB","DCBA"],"nullable":true,"type":"string"},"readMode":{"enum":["single_value","consecutive_values","gapped_values"],"nullable":true,"type":"string"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["siemens-step7"],"nullable":false,"type":"string"},"pdu":{"maximum":2147483647,"minimum":-2147483648,"nullable":true,"type":"integer","format":"int32"},"rack":{"maximum":7,"nullable":true,"type":"integer","format":"int32"},"slot":{"maximum":31,"nullable":true,"type":"integer","format":"int32"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["opc-ua"],"nullable":false,"type":"string"},"authenticationType":{"enum":["anonymous","username","certificate"],"nullable":false,"type":"string"},"username":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"password":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"securityMode":{"enum":["sign","signandencrypt"],"nullable":true,"type":"string"},"securityPolicy":{"enum":["basic256sha256","aes128_sha256_rsaoaep","aes256_sha256_rsapss"],"nullable":true,"type":"string"}},"required":["publicId","authenticationType"]},{"type":"object","properties":{"publicId":{"enum":["ethernet-ip"],"nullable":false,"type":"string"},"cpu":{"enum":["compactlogix","micro800","micrologix","micrologix800","omron"],"nullable":false,"type":"string"},"rack":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"slot":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"}},"required":["publicId","cpu"]},{"type":"object","properties":{"publicId":{"enum":["host"],"nullable":false,"type":"string"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["bacnet-ip"],"nullable":false,"type":"string"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["mc-protocol"],"nullable":false,"type":"string"},"cpu":{"enum":["FX5U","IQR","L","Q","QNUCPU"],"nullable":true,"type":"string"},"protocol":{"enum":["TCP","UDP"],"nullable":true,"type":"string"},"networkNo":{"maximum":255,"nullable":true,"type":"integer","format":"int32"},"pcNo":{"maxLength":2,"minLength":1,"nullable":true,"pattern":"[A-Za-z0-9]+","type":"string"},"requestDestIoNr":{"maxLength":4,"minLength":1,"nullable":true,"pattern":"[A-Za-z0-9]+","type":"string"},"requestDestModuleStatNr":{"maximum":255,"nullable":true,"type":"integer","format":"int32"},"authenticationType":{"enum":["none","password"],"nullable":true,"type":"string"},"password":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"reconnectDelay":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"maxBlocks":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"maxPoints":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"}},"required":["publicId"]}]},"port":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"pullDelay":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"mqttTopic":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"mqttBrokerClient":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}},"required":["device","name","slug","protocol"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"patch":{"tags":["AgentDataSourceList"],"summary":"AgentDataSourceList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"continueLoggingOnError":{"nullable":true,"type":"boolean"},"device":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"gracePeriod":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"slug":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"^[a-zA-Z0-9_\\[\\]-]+$","type":"string"},"disabled":{"nullable":false,"type":"boolean"},"protocol":{"oneOf":[{"type":"object","properties":{"publicId":{"enum":["custom"],"nullable":false,"type":"string"},"password":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}},"required":["publicId","password"]},{"type":"object","properties":{"publicId":{"enum":["modbus"],"nullable":false,"type":"string"},"slave":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"format":{"enum":["ABCD","BADC","CDAB","DCBA"],"nullable":true,"type":"string"},"readMode":{"enum":["single_value","consecutive_values","gapped_values"],"nullable":true,"type":"string"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["siemens-step7"],"nullable":false,"type":"string"},"pdu":{"maximum":2147483647,"minimum":-2147483648,"nullable":true,"type":"integer","format":"int32"},"rack":{"maximum":7,"nullable":true,"type":"integer","format":"int32"},"slot":{"maximum":31,"nullable":true,"type":"integer","format":"int32"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["opc-ua"],"nullable":false,"type":"string"},"authenticationType":{"enum":["anonymous","username","certificate"],"nullable":false,"type":"string"},"username":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"password":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"securityMode":{"enum":["sign","signandencrypt"],"nullable":true,"type":"string"},"securityPolicy":{"enum":["basic256sha256","aes128_sha256_rsaoaep","aes256_sha256_rsapss"],"nullable":true,"type":"string"}},"required":["publicId","authenticationType"]},{"type":"object","properties":{"publicId":{"enum":["ethernet-ip"],"nullable":false,"type":"string"},"cpu":{"enum":["compactlogix","micro800","micrologix","micrologix800","omron"],"nullable":false,"type":"string"},"rack":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"slot":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"}},"required":["publicId","cpu"]},{"type":"object","properties":{"publicId":{"enum":["host"],"nullable":false,"type":"string"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["bacnet-ip"],"nullable":false,"type":"string"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["mc-protocol"],"nullable":false,"type":"string"},"cpu":{"enum":["FX5U","IQR","L","Q","QNUCPU"],"nullable":true,"type":"string"},"protocol":{"enum":["TCP","UDP"],"nullable":true,"type":"string"},"networkNo":{"maximum":255,"nullable":true,"type":"integer","format":"int32"},"pcNo":{"maxLength":2,"minLength":1,"nullable":true,"pattern":"[A-Za-z0-9]+","type":"string"},"requestDestIoNr":{"maxLength":4,"minLength":1,"nullable":true,"pattern":"[A-Za-z0-9]+","type":"string"},"requestDestModuleStatNr":{"maximum":255,"nullable":true,"type":"integer","format":"int32"},"authenticationType":{"enum":["none","password"],"nullable":true,"type":"string"},"password":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"reconnectDelay":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"maxBlocks":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"maxPoints":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"}},"required":["publicId"]}]},"port":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"pullDelay":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"mqttTopic":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"mqttBrokerClient":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}},"required":["publicId","protocol"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"delete":{"tags":["AgentDataSourceList"],"summary":"AgentDataSourceList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/agents/{agentId}/data-tags/{publicId}":{"get":{"tags":["AgentDataTag"],"summary":"AgentDataTag","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"device":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"source":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"variable":{"nullable":false,"type":"object","properties":{"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"device":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"source":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"variableId":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"address":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"slug":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"^[a-zA-Z0-9_\\[\\]-]+$","type":"string"},"type":{"enum":["bool","int","float","str"],"nullable":false,"type":"string"},"signed":{"nullable":true,"type":"boolean"},"width":{"enum":["8","16","32","64"],"nullable":true,"type":"string"},"factor":{"nullable":true,"type":"string"},"unit":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"maxStringLength":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"forAlarming":{"nullable":false,"type":"boolean"},"forLogging":{"nullable":false,"type":"boolean"},"internalUse":{"nullable":false,"type":"boolean"},"updateable":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"}}},"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"backendComponent":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}}},"tagId":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"slug":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"^[a-zA-Z0-9_\\[\\]-]+$","type":"string"},"aggregators":{"type":"array","items":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}},"downsamplingInterval":{"maxLength":255,"minLength":1,"nullable":true,"pattern":"(\\d+)(ms|s|m|h|d)","type":"string"},"edgeAggregator":{"enum":["any","avg","min","max","first","last","shortest","longest","increase"],"nullable":true,"type":"string"},"logEvent":{"enum":["interval","change","trigger"],"nullable":false,"type":"string"},"logTrigger":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"loggingInterval":{"maxLength":255,"minLength":1,"nullable":true,"pattern":"([1-9]\\d*)(ms|s|m|h)","type":"string"},"retentionPolicy":{"enum":["3d","7d","14d","26w","52w","104w","260w","364w","520w"],"nullable":true,"type":"string"},"onChangeExpiry":{"maxLength":255,"minLength":1,"nullable":true,"pattern":"(\\d+)(ms|s|m|h|d)","type":"string"}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"patch":{"tags":["AgentDataTag"],"summary":"AgentDataTag","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"slug":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"^[a-zA-Z0-9_\\[\\]-]+$","type":"string"},"aggregators":{"type":"array","items":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}},"downsamplingInterval":{"maxLength":255,"minLength":1,"nullable":true,"pattern":"(\\d+)(ms|s|m|h|d)","type":"string"},"edgeAggregator":{"enum":["any","avg","min","max","first","last","shortest","longest","increase"],"nullable":true,"type":"string"},"logEvent":{"enum":["interval","change","trigger"],"nullable":false,"type":"string"},"logTrigger":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"loggingInterval":{"maxLength":255,"minLength":1,"nullable":false,"pattern":"([1-9]\\d*)(ms|s|m|h)","type":"string"},"retentionPolicy":{"enum":["3d","7d","14d","26w","52w","104w","260w","364w","520w"],"nullable":false,"type":"string"},"onChangeExpiry":{"maxLength":255,"minLength":1,"nullable":true,"pattern":"(\\d+)(ms|s|m|h|d)","type":"string"}}}}}},"security":[{"bearerToken":[]}]},"delete":{"tags":["AgentDataTag"],"summary":"AgentDataTag","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/agents/{agentId}/data-tags":{"get":{"tags":["AgentDataTagList"],"summary":"AgentDataTagList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"device":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"source":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"variable":{"nullable":false,"type":"object","properties":{"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"device":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"source":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"variableId":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"address":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"slug":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"^[a-zA-Z0-9_\\[\\]-]+$","type":"string"},"type":{"enum":["bool","int","float","str"],"nullable":false,"type":"string"},"signed":{"nullable":true,"type":"boolean"},"width":{"enum":["8","16","32","64"],"nullable":true,"type":"string"},"factor":{"nullable":true,"type":"string"},"unit":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"maxStringLength":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"forAlarming":{"nullable":false,"type":"boolean"},"forLogging":{"nullable":false,"type":"boolean"},"internalUse":{"nullable":false,"type":"boolean"},"updateable":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"}}},"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"backendComponent":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}}},"tagId":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"slug":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"^[a-zA-Z0-9_\\[\\]-]+$","type":"string"},"aggregators":{"type":"array","items":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}},"downsamplingInterval":{"maxLength":255,"minLength":1,"nullable":true,"pattern":"(\\d+)(ms|s|m|h|d)","type":"string"},"edgeAggregator":{"enum":["any","avg","min","max","first","last","shortest","longest","increase"],"nullable":true,"type":"string"},"logEvent":{"enum":["interval","change","trigger"],"nullable":false,"type":"string"},"logTrigger":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"loggingInterval":{"maxLength":255,"minLength":1,"nullable":true,"pattern":"([1-9]\\d*)(ms|s|m|h)","type":"string"},"retentionPolicy":{"enum":["3d","7d","14d","26w","52w","104w","260w","364w","520w"],"nullable":true,"type":"string"},"onChangeExpiry":{"maxLength":255,"minLength":1,"nullable":true,"pattern":"(\\d+)(ms|s|m|h|d)","type":"string"}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"post":{"tags":["AgentDataTagList"],"summary":"AgentDataTagList","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"backendComponent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"variable":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"slug":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"^[a-zA-Z0-9_\\[\\]-]+$","type":"string"},"aggregators":{"type":"array","items":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}},"downsamplingInterval":{"maxLength":255,"minLength":1,"nullable":true,"pattern":"(\\d+)(ms|s|m|h|d)","type":"string"},"edgeAggregator":{"enum":["any","avg","min","max","first","last","shortest","longest","increase"],"nullable":true,"type":"string"},"logEvent":{"enum":["interval","change","trigger"],"nullable":false,"type":"string"},"logTrigger":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"loggingInterval":{"maxLength":255,"minLength":1,"nullable":false,"pattern":"([1-9]\\d*)(ms|s|m|h)","type":"string"},"retentionPolicy":{"enum":["3d","7d","14d","26w","52w","104w","260w","364w","520w"],"nullable":false,"type":"string"},"onChangeExpiry":{"maxLength":255,"minLength":1,"nullable":true,"pattern":"(\\d+)(ms|s|m|h|d)","type":"string"}},"required":["variable","name","slug","logEvent","loggingInterval"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"patch":{"tags":["AgentDataTagList"],"summary":"AgentDataTagList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"slug":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"^[a-zA-Z0-9_\\[\\]-]+$","type":"string"},"aggregators":{"type":"array","items":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}},"downsamplingInterval":{"maxLength":255,"minLength":1,"nullable":true,"pattern":"(\\d+)(ms|s|m|h|d)","type":"string"},"edgeAggregator":{"enum":["any","avg","min","max","first","last","shortest","longest","increase"],"nullable":true,"type":"string"},"logEvent":{"enum":["interval","change","trigger"],"nullable":false,"type":"string"},"logTrigger":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"loggingInterval":{"maxLength":255,"minLength":1,"nullable":false,"pattern":"([1-9]\\d*)(ms|s|m|h)","type":"string"},"retentionPolicy":{"enum":["3d","7d","14d","26w","52w","104w","260w","364w","520w"],"nullable":false,"type":"string"},"onChangeExpiry":{"maxLength":255,"minLength":1,"nullable":true,"pattern":"(\\d+)(ms|s|m|h|d)","type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"delete":{"tags":["AgentDataTagList"],"summary":"AgentDataTagList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/agents/{agentId}/data-variables/{publicId}":{"get":{"tags":["AgentDataVariable"],"summary":"AgentDataVariable","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"device":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"source":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"variableId":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"address":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"slug":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"^[a-zA-Z0-9_\\[\\]-]+$","type":"string"},"type":{"enum":["bool","int","float","str"],"nullable":false,"type":"string"},"signed":{"nullable":true,"type":"boolean"},"width":{"enum":["8","16","32","64"],"nullable":true,"type":"string"},"factor":{"nullable":true,"type":"string"},"unit":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"maxStringLength":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"forAlarming":{"nullable":false,"type":"boolean"},"forLogging":{"nullable":false,"type":"boolean"},"internalUse":{"nullable":false,"type":"boolean"},"updateable":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"patch":{"tags":["AgentDataVariable"],"summary":"AgentDataVariable","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"address":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"slug":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"^[a-zA-Z0-9_\\[\\]-]+$","type":"string"},"factor":{"nullable":true,"type":"string"},"unit":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"maxStringLength":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"custom":{"nullable":false,"type":"object"}}}}}},"security":[{"bearerToken":[]}]},"delete":{"tags":["AgentDataVariable"],"summary":"AgentDataVariable","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/agents/{agentId}/data-variables":{"get":{"tags":["AgentDataVariableList"],"summary":"AgentDataVariableList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"device":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"source":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"variableId":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"address":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"slug":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"^[a-zA-Z0-9_\\[\\]-]+$","type":"string"},"type":{"enum":["bool","int","float","str"],"nullable":false,"type":"string"},"signed":{"nullable":true,"type":"boolean"},"width":{"enum":["8","16","32","64"],"nullable":true,"type":"string"},"factor":{"nullable":true,"type":"string"},"unit":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"maxStringLength":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"forAlarming":{"nullable":false,"type":"boolean"},"forLogging":{"nullable":false,"type":"boolean"},"internalUse":{"nullable":false,"type":"boolean"},"updateable":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"post":{"tags":["AgentDataVariableList"],"summary":"AgentDataVariableList","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"source":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"slug":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"^[a-zA-Z0-9_\\[\\]-]+$","type":"string"},"address":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"type":{"enum":["bool","int","float","str"],"nullable":false,"type":"string"},"signed":{"nullable":false,"type":"boolean"},"width":{"enum":["8","16","32","64"],"nullable":false,"type":"string"},"factor":{"nullable":true,"type":"string"},"unit":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"maxStringLength":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"custom":{"nullable":false,"type":"object"}},"required":["source","name","slug","address","type"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"patch":{"tags":["AgentDataVariableList"],"summary":"AgentDataVariableList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"address":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"slug":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"^[a-zA-Z0-9_\\[\\]-]+$","type":"string"},"factor":{"nullable":true,"type":"string"},"unit":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"maxStringLength":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"custom":{"nullable":false,"type":"object"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"delete":{"tags":["AgentDataVariableList"],"summary":"AgentDataVariableList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/agents/{agentId}/devices/{publicId}":{"get":{"tags":["AgentDevice"],"summary":"AgentDevice","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"ipAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"macAddress":{"maxLength":17,"minLength":17,"nullable":true,"pattern":"[0-9a-fA-F]{2}(:[0-9a-fA-F]{2}){5}","type":"string"},"customAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"dataSources":{"type":"array","items":{"nullable":false,"type":"object","properties":{"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"continueLoggingOnError":{"nullable":true,"type":"boolean"},"device":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"gracePeriod":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"slug":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"^[a-zA-Z0-9_\\[\\]-]+$","type":"string"},"disabled":{"nullable":false,"type":"boolean"},"protocol":{"oneOf":[{"type":"object","properties":{"publicId":{"enum":["custom"],"nullable":false,"type":"string"},"password":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}},"required":["publicId","password"]},{"type":"object","properties":{"publicId":{"enum":["modbus"],"nullable":false,"type":"string"},"slave":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"format":{"enum":["ABCD","BADC","CDAB","DCBA"],"nullable":true,"type":"string"},"readMode":{"enum":["single_value","consecutive_values","gapped_values"],"nullable":true,"type":"string"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["siemens-step7"],"nullable":false,"type":"string"},"pdu":{"maximum":2147483647,"minimum":-2147483648,"nullable":true,"type":"integer","format":"int32"},"rack":{"maximum":7,"nullable":true,"type":"integer","format":"int32"},"slot":{"maximum":31,"nullable":true,"type":"integer","format":"int32"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["opc-ua"],"nullable":false,"type":"string"},"authenticationType":{"enum":["anonymous","username","certificate"],"nullable":false,"type":"string"},"username":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"password":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"securityMode":{"enum":["sign","signandencrypt"],"nullable":true,"type":"string"},"securityPolicy":{"enum":["basic256sha256","aes128_sha256_rsaoaep","aes256_sha256_rsapss"],"nullable":true,"type":"string"}},"required":["publicId","authenticationType"]},{"type":"object","properties":{"publicId":{"enum":["ethernet-ip"],"nullable":false,"type":"string"},"cpu":{"enum":["compactlogix","micro800","micrologix","micrologix800","omron"],"nullable":false,"type":"string"},"rack":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"slot":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"}},"required":["publicId","cpu"]},{"type":"object","properties":{"publicId":{"enum":["host"],"nullable":false,"type":"string"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["bacnet-ip"],"nullable":false,"type":"string"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["mc-protocol"],"nullable":false,"type":"string"},"cpu":{"enum":["FX5U","IQR","L","Q","QNUCPU"],"nullable":true,"type":"string"},"protocol":{"enum":["TCP","UDP"],"nullable":true,"type":"string"},"networkNo":{"maximum":255,"nullable":true,"type":"integer","format":"int32"},"pcNo":{"maxLength":2,"minLength":1,"nullable":true,"pattern":"[A-Za-z0-9]+","type":"string"},"requestDestIoNr":{"maxLength":4,"minLength":1,"nullable":true,"pattern":"[A-Za-z0-9]+","type":"string"},"requestDestModuleStatNr":{"maximum":255,"nullable":true,"type":"integer","format":"int32"},"authenticationType":{"enum":["none","password"],"nullable":true,"type":"string"},"password":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"reconnectDelay":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"maxBlocks":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"maxPoints":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"}},"required":["publicId"]}]},"port":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"pullDelay":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"valuesPerHour":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"mqttTopic":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"mqttBrokerClient":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"patch":{"tags":["AgentDevice"],"summary":"AgentDevice","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"ipAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"macAddress":{"maxLength":17,"minLength":17,"nullable":true,"pattern":"[0-9a-fA-F]{2}(:[0-9a-fA-F]{2}){5}","type":"string"},"customAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"}}}}}},"security":[{"bearerToken":[]}]},"delete":{"tags":["AgentDevice"],"summary":"AgentDevice","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/agents/{agentId}/devices":{"get":{"tags":["AgentDeviceList"],"summary":"AgentDeviceList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"ipAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"macAddress":{"maxLength":17,"minLength":17,"nullable":true,"pattern":"[0-9a-fA-F]{2}(:[0-9a-fA-F]{2}){5}","type":"string"},"customAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"dataSources":{"type":"array","items":{"nullable":false,"type":"object","properties":{"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"continueLoggingOnError":{"nullable":true,"type":"boolean"},"device":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"gracePeriod":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"slug":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"^[a-zA-Z0-9_\\[\\]-]+$","type":"string"},"disabled":{"nullable":false,"type":"boolean"},"protocol":{"oneOf":[{"type":"object","properties":{"publicId":{"enum":["custom"],"nullable":false,"type":"string"},"password":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}},"required":["publicId","password"]},{"type":"object","properties":{"publicId":{"enum":["modbus"],"nullable":false,"type":"string"},"slave":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"format":{"enum":["ABCD","BADC","CDAB","DCBA"],"nullable":true,"type":"string"},"readMode":{"enum":["single_value","consecutive_values","gapped_values"],"nullable":true,"type":"string"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["siemens-step7"],"nullable":false,"type":"string"},"pdu":{"maximum":2147483647,"minimum":-2147483648,"nullable":true,"type":"integer","format":"int32"},"rack":{"maximum":7,"nullable":true,"type":"integer","format":"int32"},"slot":{"maximum":31,"nullable":true,"type":"integer","format":"int32"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["opc-ua"],"nullable":false,"type":"string"},"authenticationType":{"enum":["anonymous","username","certificate"],"nullable":false,"type":"string"},"username":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"password":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"securityMode":{"enum":["sign","signandencrypt"],"nullable":true,"type":"string"},"securityPolicy":{"enum":["basic256sha256","aes128_sha256_rsaoaep","aes256_sha256_rsapss"],"nullable":true,"type":"string"}},"required":["publicId","authenticationType"]},{"type":"object","properties":{"publicId":{"enum":["ethernet-ip"],"nullable":false,"type":"string"},"cpu":{"enum":["compactlogix","micro800","micrologix","micrologix800","omron"],"nullable":false,"type":"string"},"rack":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"slot":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"}},"required":["publicId","cpu"]},{"type":"object","properties":{"publicId":{"enum":["host"],"nullable":false,"type":"string"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["bacnet-ip"],"nullable":false,"type":"string"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["mc-protocol"],"nullable":false,"type":"string"},"cpu":{"enum":["FX5U","IQR","L","Q","QNUCPU"],"nullable":true,"type":"string"},"protocol":{"enum":["TCP","UDP"],"nullable":true,"type":"string"},"networkNo":{"maximum":255,"nullable":true,"type":"integer","format":"int32"},"pcNo":{"maxLength":2,"minLength":1,"nullable":true,"pattern":"[A-Za-z0-9]+","type":"string"},"requestDestIoNr":{"maxLength":4,"minLength":1,"nullable":true,"pattern":"[A-Za-z0-9]+","type":"string"},"requestDestModuleStatNr":{"maximum":255,"nullable":true,"type":"integer","format":"int32"},"authenticationType":{"enum":["none","password"],"nullable":true,"type":"string"},"password":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"reconnectDelay":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"maxBlocks":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"maxPoints":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"}},"required":["publicId"]}]},"port":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"pullDelay":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"valuesPerHour":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"mqttTopic":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"mqttBrokerClient":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"post":{"tags":["AgentDeviceList"],"summary":"AgentDeviceList","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"name":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"ipAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"macAddress":{"maxLength":17,"minLength":17,"nullable":true,"pattern":"[0-9a-fA-F]{2}(:[0-9a-fA-F]{2}){5}","type":"string"},"customAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"}}}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"patch":{"tags":["AgentDeviceList"],"summary":"AgentDeviceList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"ipAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"macAddress":{"maxLength":17,"minLength":17,"nullable":true,"pattern":"[0-9a-fA-F]{2}(:[0-9a-fA-F]{2}){5}","type":"string"},"customAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"delete":{"tags":["AgentDeviceList"],"summary":"AgentDeviceList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/agents/{agentId}/edge-app-instances/{publicId}":{"get":{"tags":["AgentEdgeAppInstance"],"summary":"AgentEdgeAppInstance","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"edgeAppVersion":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"status":{"enum":["error","deploying","pending","running","deleting"],"nullable":false,"type":"string"},"progress":{"nullable":false},"differentConfigs":{"nullable":false,"type":"boolean"},"lastEvent":{"nullable":true,"type":"string","format":"date-time"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"services":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"instance":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"name":{"maxLength":63,"minLength":1,"nullable":false,"type":"string"},"overrides":{"nullable":false,"type":"object","properties":{"environment":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"}}}}}},"files":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"path":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"edgeAppVersion":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"agentEdgeAppInstance":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"patch":{"tags":["AgentEdgeAppInstance"],"summary":"AgentEdgeAppInstance","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"edgeAppVersion":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}},"required":["edgeAppVersion"]}}}},"security":[{"bearerToken":[]}]}},"/agents/{agentId}/edge-app-instances/{publicId}/delete":{"post":{"tags":["AgentEdgeAppInstanceDelete"],"summary":"AgentEdgeAppInstanceDelete","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/agents/{agentId}/edge-app-instances/delete":{"post":{"tags":["AgentEdgeAppInstanceDeleteList"],"summary":"AgentEdgeAppInstanceDeleteList","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/agents/{agentId}/edge-app-instances/{publicId}/deploy":{"post":{"tags":["AgentEdgeAppInstanceDeploy"],"summary":"AgentEdgeAppInstanceDeploy","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/agents/{agentId}/edge-app-instances/deploy":{"post":{"tags":["AgentEdgeAppInstanceDeployList"],"summary":"AgentEdgeAppInstanceDeployList","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/agents/edge-app-instances/files/{publicId}":{"delete":{"tags":["AgentEdgeAppInstanceFile"],"summary":"AgentEdgeAppInstanceFile","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/agents/edge-app-instances/files":{"delete":{"tags":["AgentEdgeAppInstanceFileList"],"summary":"AgentEdgeAppInstanceFileList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/agents/{agentId}/edge-app-instances/{instanceId}/files/upload":{"post":{"tags":["AgentEdgeAppInstanceFileUpload"],"summary":"AgentEdgeAppInstanceFileUpload","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}},{"required":true,"name":"instanceId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"image/*":{"schema":{"type":"string","format":"binary"}}},"description":"This endpoint requires a file upload"},"security":[{"bearerToken":[]}]}},"/agents/{agentId}/edge-app-instances":{"get":{"tags":["AgentEdgeAppInstanceList"],"summary":"AgentEdgeAppInstanceList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"edgeAppVersion":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"status":{"enum":["error","deploying","pending","running","deleting"],"nullable":false,"type":"string"},"progress":{"nullable":false},"differentConfigs":{"nullable":false,"type":"boolean"},"lastEvent":{"nullable":true,"type":"string","format":"date-time"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"services":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"instance":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"name":{"maxLength":63,"minLength":1,"nullable":false,"type":"string"},"overrides":{"nullable":false,"type":"object","properties":{"environment":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"}}}}}},"files":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"path":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"edgeAppVersion":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"agentEdgeAppInstance":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"post":{"tags":["AgentEdgeAppInstanceList"],"summary":"AgentEdgeAppInstanceList","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"edgeAppVersion":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}},"required":["edgeAppVersion","name"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"patch":{"tags":["AgentEdgeAppInstanceList"],"summary":"AgentEdgeAppInstanceList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"edgeAppVersion":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}},"required":["publicId","edgeAppVersion"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/agents/{agentId}/edge-app-instances/services/{publicId}":{"get":{"tags":["AgentEdgeAppInstanceService"],"summary":"AgentEdgeAppInstanceService","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"instance":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"name":{"maxLength":63,"minLength":1,"nullable":false,"type":"string"},"overrides":{"nullable":false,"type":"object","properties":{"environment":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"patch":{"tags":["AgentEdgeAppInstanceService"],"summary":"AgentEdgeAppInstanceService","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"overrides":{"nullable":false,"type":"object","properties":{"environment":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"}}}},"required":["overrides"]}}}},"security":[{"bearerToken":[]}]}},"/agents/{agentId}/edge-app-instances/services":{"patch":{"tags":["AgentEdgeAppInstanceServiceList"],"summary":"AgentEdgeAppInstanceServiceList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"overrides":{"nullable":false,"type":"object","properties":{"environment":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"}}}},"required":["publicId","overrides"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/agents/{agentId}/firmware-upgrade":{"post":{"tags":["AgentFirmwareUpgrade"],"summary":"AgentFirmwareUpgrade","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"file":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"version":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}},"required":["file"]}}}},"security":[{"bearerToken":[]}]}},"/agents/{publicId}/from-template":{"patch":{"tags":["AgentFromTemplate"],"summary":"AgentFromTemplate","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"template":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"importCustomProperties":{"nullable":false,"type":"boolean"},"importDisplaySettings":{"nullable":false,"type":"boolean"},"importLanSettings":{"nullable":false,"type":"boolean"},"importFirewallSettings":{"nullable":false,"type":"boolean"},"importPageLinks":{"nullable":false,"type":"boolean"},"importServices":{"nullable":false,"type":"boolean"},"importDataSettings":{"nullable":false,"type":"boolean"},"importVpnSettings":{"nullable":false,"type":"boolean"}},"required":["template"]}}}},"security":[{"bearerToken":[]}]}},"/agents/licence-bundles/activate":{"post":{"tags":["AgentLicenceBundleActivate"],"summary":"AgentLicenceBundleActivate","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"couponCode":{"maxLength":15,"minLength":15,"nullable":false,"pattern":"([1-9]{3}|[B-DF-HJ-NP-TV-Z]{3})(-([1-9]{3}|[B-DF-HJ-NP-TV-Z]{3})){3}","type":"string"},"bundle":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}}}},"security":[{"bearerToken":[]}]}},"/agents/{agentId}/licence-bundles/activate":{"delete":{"tags":["AgentLicenceBundles"],"summary":"AgentLicenceBundles","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/agents":{"get":{"tags":["AgentList"],"summary":"AgentList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"deviceId":{"maxLength":128,"minLength":1,"nullable":false,"type":"string"},"type":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"additionalSubnets":{"nullable":false,"type":"boolean"},"allowDataPublishing":{"nullable":false,"type":"boolean"},"allowDemoDevice":{"nullable":false,"type":"boolean"},"allowTemplating":{"nullable":false,"type":"boolean"},"allowReboot":{"nullable":false,"type":"boolean"},"configPush":{"nullable":false,"type":"boolean"},"configFileFormat":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"customServers":{"nullable":false,"type":"boolean"},"deviceIdFormat":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"httpProxyPort":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"latestFirmwareFile":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"code":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"notes":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"agentType":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"type":{"enum":["firmware"],"nullable":false,"type":"string"},"latest":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"offlineConfiguration":{"nullable":false,"type":"boolean"},"openvpnConfigMultiUse":{"nullable":false,"type":"boolean"},"purchasePrice":{"nullable":false,"type":"object","properties":{"gratis":{"nullable":false,"type":"boolean"}}},"router":{"nullable":false,"type":"boolean"},"stunnelSupport":{"nullable":false,"type":"boolean"},"wanPortForwardings":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"},"hasSecondWanPort":{"nullable":false,"type":"boolean"}}},"location":{"nullable":true,"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"latitude":{"nullable":false,"type":"string"},"longitude":{"nullable":false,"type":"string"}}},"geoLocation":{"nullable":true,"type":"object","properties":{"latitude":{"nullable":false,"type":"string"},"longitude":{"nullable":false,"type":"string"},"country":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"city":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"timeZone":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"custom":{"nullable":false,"type":"object"},"description":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"useStunnel":{"nullable":false,"type":"boolean"},"preferLocationOverGeoip":{"nullable":false,"type":"boolean"},"reRegistration":{"nullable":false,"type":"boolean"},"replaceRegistration":{"nullable":false,"type":"boolean"},"replaceMacAddress":{"maxLength":17,"minLength":0,"nullable":true,"pattern":"[0-9a-fA-F]{2}(:[0-9a-fA-F]{2}){5}","type":"string"},"fixedVpnAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"macAddress":{"maxLength":17,"minLength":1,"nullable":false,"type":"string"},"serialNumber":{"maxLength":128,"minLength":1,"nullable":false,"type":"string"},"pullCodeGeneratedOn":{"nullable":true,"type":"string","format":"date-time"},"controlKeyGeneratedOn":{"nullable":true,"type":"string","format":"date-time"},"lastSeenAgentUserAgent":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"value":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"configName":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"configVersion":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"hardware":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"hardwareCode":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"hardwareVersion":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"firmwareVersion":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"osName":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"osVersion":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"appName":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"appVersion":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"packageName":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"packageVersion":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"libixagentVersion":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"libixloggerVersion":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"logOnTrigger":{"nullable":false,"type":"boolean"},"alarming":{"nullable":false,"type":"boolean"},"dataMonitoring":{"nullable":false,"type":"boolean"},"wifi":{"nullable":false,"type":"boolean"},"remoteFirmwareUpgrade":{"nullable":false,"type":"boolean"},"staticMapping":{"nullable":false,"type":"boolean"},"stewardConfigPush":{"nullable":false,"type":"boolean"},"wanInterfaceEth0":{"nullable":false,"type":"boolean"},"wanInterfaceWifi0":{"nullable":false,"type":"boolean"},"wanInterfaceCell0":{"enum":["3G","4G","neither"],"nullable":false,"type":"string"},"multiWan":{"nullable":false,"type":"boolean"},"openvpnVersion":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"openvpnOccEnabled":{"nullable":false,"type":"boolean"},"openvpnOpensslVersion":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"}}},"networkValues":{"type":"array","items":{"nullable":false,"type":"object","properties":{"interface":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"value":{"type":"array","items":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}}}}},"networkReportedOn":{"nullable":true,"type":"string","format":"date-time"},"activeStatus":{"enum":["active","inactive"],"nullable":false,"type":"string"},"activationLicence":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"type":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"usageType":{"enum":["advanced-user-management","agent-registration-profile","agent-templates","alarming","api-integrations","app-engine-level-1","app-engine-level-2","app-engine-level-3","asset-management","card-view","connection-monitoring","controlled-devices","custom-branding","custom-domain","custom-fields","custom-legal","custom-legal-legacy","custom-sso","edge-app-management","ixagent","landing-page","live-data","logging","m2m-cloud-cluster","main-pages","mobile-app","mqtt-device","object-storage","premium-branding","rdp","remote-access","reporting","request-access","rtsp","scim","session-recording","sla","ssh","subgroups","temporary-access","vpn-access-rule","vpn-usage"],"nullable":false,"type":"string"},"companyLimit":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"scope":{"enum":["agent","company"],"nullable":false,"type":"string"}}},"serialNumber":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"expiresOn":{"nullable":true,"type":"string","format":"date-time"},"activated":{"nullable":false,"type":"boolean"},"trial":{"nullable":false,"type":"boolean"},"value":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"locked":{"nullable":true,"type":"boolean"},"maxRetentionPolicy":{"maxLength":255,"minLength":2,"nullable":true,"type":"string"},"bundle":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}},"pendingRegistration":{"nullable":false,"type":"boolean"},"card":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"activeVpnSession":{"nullable":true,"type":"object","properties":{"rscServer":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"vpnRange":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"supportedLayers":{"type":"array","items":{"enum":["tun","tap"],"nullable":false,"type":"string"}},"location":{"nullable":false,"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"latitude":{"nullable":false,"type":"string"},"longitude":{"nullable":false,"type":"string"}}}}},"startedOn":{"nullable":false,"type":"string","format":"date-time"},"sessionName":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"vpnAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"closed":{"nullable":false,"type":"boolean"}}},"vpnChangedOn":{"nullable":true,"type":"string","format":"date-time"},"mdrServer":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"mqttChangedOn":{"nullable":true,"type":"string","format":"date-time"},"loggingMdrServer":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"loggingMqttChangedOn":{"nullable":true,"type":"string","format":"date-time"},"lsiServer":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"company":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":24,"minLength":24,"nullable":false,"pattern":"(\\d{4}-){4}\\d{4}","type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"controlledBy":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":24,"minLength":24,"nullable":false,"pattern":"(\\d{4}-){4}\\d{4}","type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"vpnAudience":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"custom":{"nullable":false,"type":"object"},"default":{"nullable":false,"type":"boolean"},"type":{"enum":["alarm","page","service"],"nullable":true,"type":"string"}}},"vpnRequireAccessApproval":{"nullable":false,"type":"boolean"},"vpnAccessRules":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"audience":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"ipAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"netMask":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}}}},"vpnVisibleInMobileApp":{"nullable":false,"type":"boolean"},"vpnVisibleOnWeb":{"nullable":false,"type":"boolean"},"dataAudience":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"custom":{"nullable":false,"type":"object"},"default":{"nullable":false,"type":"boolean"},"type":{"enum":["alarm","page","service"],"nullable":true,"type":"string"}}},"memberships":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"group":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}},"rateLimiting":{"nullable":false,"type":"object","properties":{"configMqttCommandLimit":{"enum":["soft","hard","lock"],"nullable":true,"type":"string"},"configMqttCommandCounter":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"configMqttCommandLastHit":{"nullable":true,"type":"string","format":"date-time"},"configMqttDataLimit":{"enum":["soft","hard","lock"],"nullable":true,"type":"string"},"configMqttDataCounter":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"configMqttDataLastHit":{"nullable":true,"type":"string","format":"date-time"},"configOpenvpnLimit":{"enum":["soft","hard","lock"],"nullable":true,"type":"string"},"configOpenvpnCounter":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"configOpenvpnLastHit":{"nullable":true,"type":"string","format":"date-time"}}},"vpnProtocol":{"enum":["udp","tcp"],"nullable":false,"type":"string"},"config":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"configFileServer":{"maxLength":4294967295,"minLength":0,"nullable":true,"type":"string"},"configPushedOn":{"nullable":true,"type":"string","format":"date-time"},"configFileReported":{"maxLength":4294967295,"minLength":0,"nullable":true,"type":"string"},"configFileReportedWlanKeyEnabled":{"nullable":false,"type":"boolean"},"configFileReportedCellularPasswordEnabled":{"nullable":false,"type":"boolean"},"configReportedOn":{"nullable":true,"type":"string","format":"date-time"},"differentConfigs":{"nullable":false,"type":"boolean"},"differentWanConfigs":{"nullable":false,"type":"boolean"},"stewardConfigFileServer":{"maxLength":4294967295,"minLength":0,"nullable":true,"type":"string"},"stewardConfigFileReported":{"maxLength":4294967295,"minLength":0,"nullable":true,"type":"string"},"stewardConfigReportedOn":{"nullable":true,"type":"string","format":"date-time"},"differentStewardConfigs":{"nullable":false,"type":"boolean"},"routerLan":{"nullable":false,"type":"object","properties":{"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"ipAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"netMask":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"network":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"dhcpServerEnabled":{"nullable":false,"type":"boolean"},"dhcpServerRangeFrom":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"dhcpServerRangeTo":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"gatewayLessRouting":{"nullable":false,"type":"boolean"},"forwardLanWan":{"enum":["neither","public","private","both"],"nullable":false,"type":"string"},"forwardLanWan2":{"enum":["neither","public","private","both"],"nullable":false,"type":"string"},"wlanEnable":{"nullable":true,"type":"boolean"},"wlanSsid":{"maxLength":32,"minLength":0,"nullable":true,"type":"string"},"wlanKey":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"wlanChannel":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"bacnetBbmd":{"type":"array","items":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}},"udpBroadcastRelayPort":{"type":"array","items":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}}}},"routerVpn":{"nullable":false,"type":"object","properties":{"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"sourceNatEnabled":{"nullable":false,"type":"boolean"}}},"routerWan":{"nullable":false,"type":"object","properties":{"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"multiwanPolicy":{"enum":["eth_cell_wifi","cell_eth_wifi","eth_wifi_cell","wifi_eth_cell","cell_wifi_eth","wifi_cell_eth"],"nullable":true,"type":"string"},"ipUseDhcp":{"nullable":true,"type":"boolean"},"ipAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"ipGateway":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"ipNetMask":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"dnsServers":{"type":"array","items":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}},"dnsRebindProtectionEnabled":{"nullable":true,"type":"boolean"},"cellularApn":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"cellularPincode":{"maxLength":8,"minLength":0,"nullable":true,"type":"string"},"cellularMtu":{"maximum":1500,"minimum":576,"nullable":true,"type":"integer","format":"int32"},"digitalInputMode":{"enum":["disable_vpn_high","disable_vpn_low","disable_wan_high","disable_wan_low"],"nullable":true,"type":"string"},"wanTrackInterval":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"wanTrackIps":{"type":"array","items":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}},"wlanTrackInterval":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"wlanTrackIps":{"type":"array","items":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}},"cellularTrackInterval":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"cellularTrackIps":{"type":"array","items":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}},"httpProxyAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"httpProxyPort":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"httpProxyAuthentication":{"enum":["none","basic","ntlm"],"nullable":true,"type":"string"},"httpProxyUsername":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"httpProxyIsSocks5":{"nullable":true,"type":"boolean"},"wlanSsid":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"wlanIpUseDhcp":{"nullable":true,"type":"boolean"},"wlanIpAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"wlanIpGateway":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"wlanIpNetMask":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"wlanDnsServers":{"type":"array","items":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}},"cellularUsername":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"}}},"routerDisplay":{"nullable":false,"type":"object","properties":{"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"lockEnabled":{"nullable":false,"type":"boolean"},"lockCode":{"maxLength":4,"minLength":4,"nullable":true,"pattern":"[0-9]+","type":"string"}}},"routerAdditionalSubnets":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"networkAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"networkMask":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"gatewayAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}},"routerPortForwards":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"interface":{"enum":["VPN","WAN","WAN2"],"nullable":false,"type":"string"},"targetIpAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"targetPort":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"externalPort":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}},"routerNtpServers":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"server":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}}},"demoDevice":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"expiresOn":{"nullable":false,"type":"string","format":"date-time"},"agentType":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"additionalSubnets":{"nullable":false,"type":"boolean"},"allowDataPublishing":{"nullable":false,"type":"boolean"},"allowDemoDevice":{"nullable":false,"type":"boolean"},"allowTemplating":{"nullable":false,"type":"boolean"},"allowReboot":{"nullable":false,"type":"boolean"},"configPush":{"nullable":false,"type":"boolean"},"configFileFormat":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"customServers":{"nullable":false,"type":"boolean"},"deviceIdFormat":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"httpProxyPort":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"latestFirmwareFile":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"code":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"notes":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"agentType":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"type":{"enum":["firmware"],"nullable":false,"type":"string"},"latest":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"offlineConfiguration":{"nullable":false,"type":"boolean"},"openvpnConfigMultiUse":{"nullable":false,"type":"boolean"},"purchasePrice":{"nullable":false,"type":"object","properties":{"gratis":{"nullable":false,"type":"boolean"}}},"router":{"nullable":false,"type":"boolean"},"stunnelSupport":{"nullable":false,"type":"boolean"},"wanPortForwardings":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"},"hasSecondWanPort":{"nullable":false,"type":"boolean"}}},"dmvServer":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}},"connectedUsers":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}},"loggingApp":{"nullable":false,"type":"object","properties":{"licence":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"type":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"usageType":{"enum":["advanced-user-management","agent-registration-profile","agent-templates","alarming","api-integrations","app-engine-level-1","app-engine-level-2","app-engine-level-3","asset-management","card-view","connection-monitoring","controlled-devices","custom-branding","custom-domain","custom-fields","custom-legal","custom-legal-legacy","custom-sso","edge-app-management","ixagent","landing-page","live-data","logging","m2m-cloud-cluster","main-pages","mobile-app","mqtt-device","object-storage","premium-branding","rdp","remote-access","reporting","request-access","rtsp","scim","session-recording","sla","ssh","subgroups","temporary-access","vpn-access-rule","vpn-usage"],"nullable":false,"type":"string"},"companyLimit":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"scope":{"enum":["agent","company"],"nullable":false,"type":"string"}}},"serialNumber":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"expiresOn":{"nullable":true,"type":"string","format":"date-time"},"activated":{"nullable":false,"type":"boolean"},"trial":{"nullable":false,"type":"boolean"},"value":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"locked":{"nullable":true,"type":"boolean"},"maxRetentionPolicy":{"maxLength":255,"minLength":2,"nullable":true,"type":"string"},"agent":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"deviceId":{"maxLength":128,"minLength":1,"nullable":false,"type":"string"},"type":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"location":{"nullable":false,"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"latitude":{"nullable":false,"type":"string"},"longitude":{"nullable":false,"type":"string"}}},"geoLocation":{"nullable":false,"type":"object","properties":{"latitude":{"nullable":false,"type":"string"},"longitude":{"nullable":false,"type":"string"},"country":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"city":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"custom":{"nullable":false,"type":"object"}}},"hasAgent":{"nullable":false,"type":"boolean"},"agentType":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"additionalSubnets":{"nullable":false,"type":"boolean"},"allowDataPublishing":{"nullable":false,"type":"boolean"},"allowDemoDevice":{"nullable":false,"type":"boolean"},"allowTemplating":{"nullable":false,"type":"boolean"},"allowReboot":{"nullable":false,"type":"boolean"},"configPush":{"nullable":false,"type":"boolean"},"configFileFormat":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"customServers":{"nullable":false,"type":"boolean"},"deviceIdFormat":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"httpProxyPort":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"latestFirmwareFile":{"nullable":false,"type":"object"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"offlineConfiguration":{"nullable":false,"type":"boolean"},"openvpnConfigMultiUse":{"nullable":false,"type":"boolean"},"purchasePrice":{"nullable":false,"type":"object"},"router":{"nullable":false,"type":"boolean"},"stunnelSupport":{"nullable":false,"type":"boolean"},"wanPortForwardings":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"},"hasSecondWanPort":{"nullable":false,"type":"boolean"}}},"bundle":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}},"enabled":{"nullable":false,"type":"boolean"}}},"valuesPerHour":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"alarmingApp":{"nullable":false,"type":"object","properties":{"licence":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"type":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"usageType":{"enum":["advanced-user-management","agent-registration-profile","agent-templates","alarming","api-integrations","app-engine-level-1","app-engine-level-2","app-engine-level-3","asset-management","card-view","connection-monitoring","controlled-devices","custom-branding","custom-domain","custom-fields","custom-legal","custom-legal-legacy","custom-sso","edge-app-management","ixagent","landing-page","live-data","logging","m2m-cloud-cluster","main-pages","mobile-app","mqtt-device","object-storage","premium-branding","rdp","remote-access","reporting","request-access","rtsp","scim","session-recording","sla","ssh","subgroups","temporary-access","vpn-access-rule","vpn-usage"],"nullable":false,"type":"string"},"companyLimit":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"scope":{"enum":["agent","company"],"nullable":false,"type":"string"}}},"serialNumber":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"expiresOn":{"nullable":true,"type":"string","format":"date-time"},"activated":{"nullable":false,"type":"boolean"},"trial":{"nullable":false,"type":"boolean"},"value":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"locked":{"nullable":true,"type":"boolean"},"maxRetentionPolicy":{"maxLength":255,"minLength":2,"nullable":true,"type":"string"},"agent":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"deviceId":{"maxLength":128,"minLength":1,"nullable":false,"type":"string"},"type":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"location":{"nullable":false,"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"latitude":{"nullable":false,"type":"string"},"longitude":{"nullable":false,"type":"string"}}},"geoLocation":{"nullable":false,"type":"object","properties":{"latitude":{"nullable":false,"type":"string"},"longitude":{"nullable":false,"type":"string"},"country":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"city":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"custom":{"nullable":false,"type":"object"}}},"hasAgent":{"nullable":false,"type":"boolean"},"agentType":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"additionalSubnets":{"nullable":false,"type":"boolean"},"allowDataPublishing":{"nullable":false,"type":"boolean"},"allowDemoDevice":{"nullable":false,"type":"boolean"},"allowTemplating":{"nullable":false,"type":"boolean"},"allowReboot":{"nullable":false,"type":"boolean"},"configPush":{"nullable":false,"type":"boolean"},"configFileFormat":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"customServers":{"nullable":false,"type":"boolean"},"deviceIdFormat":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"httpProxyPort":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"latestFirmwareFile":{"nullable":false,"type":"object"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"offlineConfiguration":{"nullable":false,"type":"boolean"},"openvpnConfigMultiUse":{"nullable":false,"type":"boolean"},"purchasePrice":{"nullable":false,"type":"object"},"router":{"nullable":false,"type":"boolean"},"stunnelSupport":{"nullable":false,"type":"boolean"},"wanPortForwardings":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"},"hasSecondWanPort":{"nullable":false,"type":"boolean"}}},"bundle":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}},"enabled":{"nullable":false,"type":"boolean"}}},"lanWanAccessRules":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"sourceIpAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"sourceMacAddress":{"maxLength":17,"minLength":17,"nullable":true,"pattern":"[0-9a-fA-F]{2}(:[0-9a-fA-F]{2}){5}","type":"string"},"destinationPort":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"destinationIpAddress":{"maxLength":19,"minLength":7,"nullable":true,"pattern":"\\d{1,3}(\\.\\d{1,3}){3}(\\/\\d{1,3})?","type":"string"},"protocol":{"enum":["all","tcp","udp","icmp","ah","ax.25","dccp","ddp","egp","eigrp","encap","esp","etherip","fc","ggp","gre","hmp","idpr-cmtp","idrp","igmp","igp","ipcomp","ipencap","ipip","ipv6","ipv6-frag","ipv6-icmp","ipv6-nonxt","ipv6-opts","ipv6-route","isis","iso-tp4","l2tp","ospf","pim","pup","rdp","rspf","rsvp","sctp","skip","st","vmtp","vrrp","xns-idp","xtp"],"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"}}}},"oneToOneNatRules":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"type":{"enum":["wan","wlan","vpn"],"nullable":false,"type":"string"},"virtualIpAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"destinationIpAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"protocol":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"port":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"sourceIpAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"}}}},"devices":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"ipAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"macAddress":{"maxLength":17,"minLength":17,"nullable":true,"pattern":"[0-9a-fA-F]{2}(:[0-9a-fA-F]{2}){5}","type":"string"},"customAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"dataSources":{"type":"array","items":{"nullable":false,"type":"object","properties":{"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"continueLoggingOnError":{"nullable":true,"type":"boolean"},"device":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"gracePeriod":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"slug":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"^[a-zA-Z0-9_\\[\\]-]+$","type":"string"},"disabled":{"nullable":false,"type":"boolean"},"protocol":{"oneOf":[{"type":"object","properties":{"publicId":{"enum":["custom"],"nullable":false,"type":"string"},"password":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}},"required":["publicId","password"]},{"type":"object","properties":{"publicId":{"enum":["modbus"],"nullable":false,"type":"string"},"slave":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"format":{"enum":["ABCD","BADC","CDAB","DCBA"],"nullable":true,"type":"string"},"readMode":{"enum":["single_value","consecutive_values","gapped_values"],"nullable":true,"type":"string"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["siemens-step7"],"nullable":false,"type":"string"},"pdu":{"maximum":2147483647,"minimum":-2147483648,"nullable":true,"type":"integer","format":"int32"},"rack":{"maximum":7,"nullable":true,"type":"integer","format":"int32"},"slot":{"maximum":31,"nullable":true,"type":"integer","format":"int32"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["opc-ua"],"nullable":false,"type":"string"},"authenticationType":{"enum":["anonymous","username","certificate"],"nullable":false,"type":"string"},"username":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"password":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"securityMode":{"enum":["sign","signandencrypt"],"nullable":true,"type":"string"},"securityPolicy":{"enum":["basic256sha256","aes128_sha256_rsaoaep","aes256_sha256_rsapss"],"nullable":true,"type":"string"}},"required":["publicId","authenticationType"]},{"type":"object","properties":{"publicId":{"enum":["ethernet-ip"],"nullable":false,"type":"string"},"cpu":{"enum":["compactlogix","micro800","micrologix","micrologix800","omron"],"nullable":false,"type":"string"},"rack":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"slot":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"}},"required":["publicId","cpu"]},{"type":"object","properties":{"publicId":{"enum":["host"],"nullable":false,"type":"string"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["bacnet-ip"],"nullable":false,"type":"string"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["mc-protocol"],"nullable":false,"type":"string"},"cpu":{"enum":["FX5U","IQR","L","Q","QNUCPU"],"nullable":true,"type":"string"},"protocol":{"enum":["TCP","UDP"],"nullable":true,"type":"string"},"networkNo":{"maximum":255,"nullable":true,"type":"integer","format":"int32"},"pcNo":{"maxLength":2,"minLength":1,"nullable":true,"pattern":"[A-Za-z0-9]+","type":"string"},"requestDestIoNr":{"maxLength":4,"minLength":1,"nullable":true,"pattern":"[A-Za-z0-9]+","type":"string"},"requestDestModuleStatNr":{"maximum":255,"nullable":true,"type":"integer","format":"int32"},"authenticationType":{"enum":["none","password"],"nullable":true,"type":"string"},"password":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"reconnectDelay":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"maxBlocks":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"maxPoints":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"}},"required":["publicId"]}]},"port":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"pullDelay":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"valuesPerHour":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"mqttTopic":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"mqttBrokerClient":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}}}}},"servers":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"type":{"enum":["http","rdp","rtsp","ssh","vnc","websocket"],"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"port":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"username":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"password":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"hasPassword":{"nullable":false,"type":"boolean"},"authDomain":{"maxLength":253,"minLength":4,"nullable":true,"pattern":".+(\\..[^.]+)","type":"string"},"landingPage":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"connectionQuality":{"enum":["low","normal","high"],"nullable":true,"type":"string"},"readOnly":{"nullable":true,"type":"boolean"},"vncRightClickOnTouchHold":{"nullable":false,"type":"boolean"},"vncEncoding":{"enum":["copyrect","corre","hextile","raw","rre","tight","ultra","ultrazip","zlib","zlibhex","zrle","zywrle"],"nullable":true,"type":"string"},"useSsl":{"nullable":false,"type":"boolean"},"visibleInMobileApp":{"nullable":false,"type":"boolean"},"visibleOnWeb":{"nullable":false,"type":"boolean"},"httpAuthenticationType":{"enum":["ntlm","basic","digest"],"nullable":true,"type":"string"},"recordSessions":{"nullable":true,"type":"boolean"},"audience":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"requireAccessApproval":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"device":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"serviceGroup":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"template":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"type":{"enum":["http","rdp","rtsp","ssh","vnc","websocket"],"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"port":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"username":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"password":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"hasPassword":{"nullable":false,"type":"boolean"},"authDomain":{"maxLength":253,"minLength":4,"nullable":true,"pattern":".+(\\..[^.]+)","type":"string"},"landingPage":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"connectionQuality":{"enum":["low","normal","high"],"nullable":true,"type":"string"},"readOnly":{"nullable":true,"type":"boolean"},"vncRightClickOnTouchHold":{"nullable":false,"type":"boolean"},"vncEncoding":{"enum":["copyrect","corre","hextile","raw","rre","tight","ultra","ultrazip","zlib","zlibhex","zrle","zywrle"],"nullable":true,"type":"string"},"useSsl":{"nullable":false,"type":"boolean"},"visibleInMobileApp":{"nullable":false,"type":"boolean"},"visibleOnWeb":{"nullable":false,"type":"boolean"},"httpAuthenticationType":{"enum":["ntlm","basic","digest"],"nullable":true,"type":"string"},"recordSessions":{"nullable":true,"type":"boolean"},"audience":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"requireAccessApproval":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"}}}}}},"dataSources":{"type":"array","items":{"nullable":false,"type":"object","properties":{"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"continueLoggingOnError":{"nullable":true,"type":"boolean"},"device":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"gracePeriod":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"slug":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"^[a-zA-Z0-9_\\[\\]-]+$","type":"string"},"disabled":{"nullable":false,"type":"boolean"},"protocol":{"oneOf":[{"type":"object","properties":{"publicId":{"enum":["custom"],"nullable":false,"type":"string"},"password":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}},"required":["publicId","password"]},{"type":"object","properties":{"publicId":{"enum":["modbus"],"nullable":false,"type":"string"},"slave":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"format":{"enum":["ABCD","BADC","CDAB","DCBA"],"nullable":true,"type":"string"},"readMode":{"enum":["single_value","consecutive_values","gapped_values"],"nullable":true,"type":"string"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["siemens-step7"],"nullable":false,"type":"string"},"pdu":{"maximum":2147483647,"minimum":-2147483648,"nullable":true,"type":"integer","format":"int32"},"rack":{"maximum":7,"nullable":true,"type":"integer","format":"int32"},"slot":{"maximum":31,"nullable":true,"type":"integer","format":"int32"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["opc-ua"],"nullable":false,"type":"string"},"authenticationType":{"enum":["anonymous","username","certificate"],"nullable":false,"type":"string"},"username":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"password":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"securityMode":{"enum":["sign","signandencrypt"],"nullable":true,"type":"string"},"securityPolicy":{"enum":["basic256sha256","aes128_sha256_rsaoaep","aes256_sha256_rsapss"],"nullable":true,"type":"string"}},"required":["publicId","authenticationType"]},{"type":"object","properties":{"publicId":{"enum":["ethernet-ip"],"nullable":false,"type":"string"},"cpu":{"enum":["compactlogix","micro800","micrologix","micrologix800","omron"],"nullable":false,"type":"string"},"rack":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"slot":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"}},"required":["publicId","cpu"]},{"type":"object","properties":{"publicId":{"enum":["host"],"nullable":false,"type":"string"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["bacnet-ip"],"nullable":false,"type":"string"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["mc-protocol"],"nullable":false,"type":"string"},"cpu":{"enum":["FX5U","IQR","L","Q","QNUCPU"],"nullable":true,"type":"string"},"protocol":{"enum":["TCP","UDP"],"nullable":true,"type":"string"},"networkNo":{"maximum":255,"nullable":true,"type":"integer","format":"int32"},"pcNo":{"maxLength":2,"minLength":1,"nullable":true,"pattern":"[A-Za-z0-9]+","type":"string"},"requestDestIoNr":{"maxLength":4,"minLength":1,"nullable":true,"pattern":"[A-Za-z0-9]+","type":"string"},"requestDestModuleStatNr":{"maximum":255,"nullable":true,"type":"integer","format":"int32"},"authenticationType":{"enum":["none","password"],"nullable":true,"type":"string"},"password":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"reconnectDelay":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"maxBlocks":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"maxPoints":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"}},"required":["publicId"]}]},"port":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"pullDelay":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"valuesPerHour":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"mqttTopic":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"mqttBrokerClient":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}},"pageLinks":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"asset":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"menuItem":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"page":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"audience":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"custom":{"nullable":false,"type":"object"},"default":{"nullable":false,"type":"boolean"},"type":{"enum":["alarm","page","service"],"nullable":true,"type":"string"}}},"group":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"asset":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"menuItem":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"custom":{"nullable":false,"type":"object"}}}},"scheduledAccessRequests":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"user":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"approver":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"approverCompany":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"vpn":{"nullable":false,"type":"boolean"},"servers":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}},"start":{"nullable":false,"type":"string","format":"date-time"},"end":{"nullable":false,"type":"string","format":"date-time"},"status":{"enum":["approved","pending","rejected","revoked"],"nullable":false,"type":"string"},"reason":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"createdOn":{"nullable":false,"type":"string","format":"date-time"},"updatedOn":{"nullable":true,"type":"string","format":"date-time"},"allowedApprovers":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}},"reviewExpiresOn":{"nullable":true,"type":"string","format":"date-time"}}}},"assets":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}},"registrationProfile":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":24,"minLength":24,"nullable":false,"pattern":"(\\d{4}-){4}\\d{4}","type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"agentActivationName":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"}}},"vpnLocked":{"nullable":false,"type":"boolean"},"webAccessLocked":{"nullable":false,"type":"boolean"},"appliedTemplateVersion":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"createdOn":{"nullable":false,"type":"string","format":"date-time"},"createdBy":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"company":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"description":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"agentTemplate":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"number":{"maxLength":64,"minLength":1,"nullable":false,"type":"string"}}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"}],"security":[{"bearerToken":[]}]},"patch":{"tags":["AgentList"],"summary":"AgentList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"location":{"nullable":true,"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"latitude":{"nullable":false,"type":"string"},"longitude":{"nullable":false,"type":"string"}}},"timeZone":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"custom":{"nullable":false,"type":"object"},"description":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"useStunnel":{"nullable":false,"type":"boolean"},"replaceMacAddress":{"maxLength":17,"minLength":0,"nullable":true,"pattern":"[0-9a-fA-F]{2}(:[0-9a-fA-F]{2}){5}","type":"string"},"reRegistration":{"nullable":false,"type":"boolean"},"fixedVpnAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"preferLocationOverGeoip":{"nullable":false,"type":"boolean"},"card":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"vpnAudience":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"vpnRequireAccessApproval":{"nullable":false,"type":"boolean"},"vpnVisibleInMobileApp":{"nullable":false,"type":"boolean"},"vpnVisibleOnWeb":{"nullable":false,"type":"boolean"},"dataAudience":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"rateLimiting":{"nullable":false,"type":"object","properties":{"configMqttCommandReset":{"nullable":true,"type":"boolean"},"configMqttDataReset":{"nullable":true,"type":"boolean"},"configOpenvpnReset":{"nullable":true,"type":"boolean"}}},"vpnProtocol":{"enum":["udp","tcp"],"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"delete":{"tags":["AgentList"],"summary":"AgentList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/agents/activate":{"post":{"tags":["AgentListActivate"],"summary":"AgentListActivate","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"couponCode":{"maxLength":15,"minLength":15,"nullable":false,"pattern":"([1-9]{3}|[B-DF-HJ-NP-TV-Z]{3})(-([1-9]{3}|[B-DF-HJ-NP-TV-Z]{3})){3}","type":"string"},"licence":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"groups":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}},"template":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}},"required":["publicId","name"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/agents/configuration/import":{"put":{"tags":["AgentListConfigurationImport"],"summary":"AgentListConfigurationImport","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/agents/configuration/push":{"post":{"tags":["AgentListConfigurationPush"],"summary":"AgentListConfigurationPush","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/agents/from-template":{"patch":{"tags":["AgentListFromTemplate"],"summary":"AgentListFromTemplate","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"template":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"importCustomProperties":{"nullable":false,"type":"boolean"},"importDisplaySettings":{"nullable":false,"type":"boolean"},"importLanSettings":{"nullable":false,"type":"boolean"},"importFirewallSettings":{"nullable":false,"type":"boolean"},"importPageLinks":{"nullable":false,"type":"boolean"},"importServices":{"nullable":false,"type":"boolean"},"importDataSettings":{"nullable":false,"type":"boolean"},"importVpnSettings":{"nullable":false,"type":"boolean"}},"required":["publicId","template"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/agents/logging-configuration/push":{"post":{"tags":["AgentListLoggingConfigurationPush"],"summary":"AgentListLoggingConfigurationPush","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/agents/connection/openvpn":{"post":{"tags":["AgentListOpenVpnConnection"],"summary":"AgentListOpenVpnConnection","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"action":{"enum":["connect","disconnect"],"nullable":false,"type":"string"}},"required":["publicId","action"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/agents/pull":{"post":{"tags":["AgentListPull"],"summary":"AgentListPull","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"device":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"pullCode":{"maxLength":11,"minLength":11,"nullable":false,"pattern":"[1-9]{3}-[B-DF-HJ-NP-TV-Z]{3}-[1-9]{3}","type":"string"},"groups":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}},"forced":{"nullable":false,"type":"boolean"}},"required":["device","pullCode"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/agents/memberships/{publicId}":{"get":{"tags":["AgentMembership"],"summary":"AgentMembership","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"group":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"patch":{"tags":["AgentMembership"],"summary":"AgentMembership","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"group":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}},"required":["agent","group"]}}}},"security":[{"bearerToken":[]}]},"delete":{"tags":["AgentMembership"],"summary":"AgentMembership","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/agents/memberships":{"get":{"tags":["AgentMembershipList"],"summary":"AgentMembershipList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"group":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"}],"security":[{"bearerToken":[]}]},"post":{"tags":["AgentMembershipList"],"summary":"AgentMembershipList","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"group":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}},"required":["agent","group"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"patch":{"tags":["AgentMembershipList"],"summary":"AgentMembershipList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"group":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}},"required":["publicId","agent","group"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"delete":{"tags":["AgentMembershipList"],"summary":"AgentMembershipList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/agents/{agentId}/object-storage/delete":{"post":{"tags":["AgentObjectStorageDeleteAction"],"summary":"AgentObjectStorageDeleteAction","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"template":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"uuid":{"maxLength":36,"minLength":36,"nullable":false,"type":"string","format":"uuid"},"arguments":{"nullable":true}},"required":["template","uuid"]}}}},"security":[{"bearerToken":[]}]}},"/agents/{agentId}/object-storage/download":{"post":{"tags":["AgentObjectStorageDownloadAction"],"summary":"AgentObjectStorageDownloadAction","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"url":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}},"required":["url"]}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"template":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"uuid":{"maxLength":36,"minLength":36,"nullable":false,"type":"string","format":"uuid"},"arguments":{"nullable":true}},"required":["template","uuid"]}}}},"security":[{"bearerToken":[]}]}},"/agents/{agentId}/object-storage/list":{"post":{"tags":["AgentObjectStorageListAction"],"summary":"AgentObjectStorageListAction","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"uuid":{"maxLength":36,"minLength":36,"nullable":false,"type":"string","format":"uuid"},"size":{"maximum":2147483647,"minimum":-2147483648,"nullable":false,"type":"integer","format":"int32"},"tags":{"maxLength":65535,"nullable":false,"type":"object"},"agent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"asset":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}},"required":["uuid","size","tags"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"template":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"arguments":{"nullable":true}},"required":["template"]}}}},"security":[{"bearerToken":[]}]}},"/agents/{agentId}/object-storage/meta":{"patch":{"tags":["AgentObjectStorageObjectMetaUpdateAction"],"summary":"AgentObjectStorageObjectMetaUpdateAction","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"uuid":{"maxLength":36,"minLength":36,"nullable":false,"type":"string","format":"uuid"},"template":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"tags":{"maxLength":65535,"nullable":false,"type":"object"}},"required":["uuid","template"]}}}},"security":[{"bearerToken":[]}]}},"/agents/{agentId}/object-storage/upload":{"post":{"tags":["AgentObjectStorageUploadAction"],"summary":"AgentObjectStorageUploadAction","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"type":{"enum":["azure-blob-storage"],"nullable":false,"type":"string"},"url":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}},"required":["type","url"]}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"template":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"uuid":{"maxLength":36,"minLength":36,"nullable":false,"type":"string","format":"uuid"},"arguments":{"nullable":true}},"required":["template","uuid"]}}}},"security":[{"bearerToken":[]}]}},"/agents/{publicId}/connection/openvpn":{"post":{"tags":["AgentOpenVpnConnection"],"summary":"AgentOpenVpnConnection","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"action":{"enum":["connect","disconnect"],"nullable":false,"type":"string"}},"required":["action"]}}}},"security":[{"bearerToken":[]}]}},"/agents/{agentId}/page-links/{publicId}":{"get":{"tags":["AgentPageLink"],"summary":"AgentPageLink","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"asset":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"menuItem":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"page":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"audience":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"custom":{"nullable":false,"type":"object"},"default":{"nullable":false,"type":"boolean"},"type":{"enum":["alarm","page","service"],"nullable":true,"type":"string"}}},"group":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"asset":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"menuItem":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"custom":{"nullable":false,"type":"object"}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"patch":{"tags":["AgentPageLink"],"summary":"AgentPageLink","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"page":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"audience":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"group":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"custom":{"nullable":false,"type":"object"}}}}}},"security":[{"bearerToken":[]}]},"delete":{"tags":["AgentPageLink"],"summary":"AgentPageLink","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/agents/{agentId}/page-link-groups/{publicId}":{"get":{"tags":["AgentPageLinkGroup"],"summary":"AgentPageLinkGroup","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"asset":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"menuItem":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"patch":{"tags":["AgentPageLinkGroup"],"summary":"AgentPageLinkGroup","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}}},"security":[{"bearerToken":[]}]},"delete":{"tags":["AgentPageLinkGroup"],"summary":"AgentPageLinkGroup","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/agents/{agentId}/page-link-groups":{"get":{"tags":["AgentPageLinkGroupList"],"summary":"AgentPageLinkGroupList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"asset":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"menuItem":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"post":{"tags":["AgentPageLinkGroupList"],"summary":"AgentPageLinkGroupList","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}},"required":["name"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"patch":{"tags":["AgentPageLinkGroupList"],"summary":"AgentPageLinkGroupList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"delete":{"tags":["AgentPageLinkGroupList"],"summary":"AgentPageLinkGroupList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/agents/{agentId}/page-links":{"get":{"tags":["AgentPageLinkList"],"summary":"AgentPageLinkList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"asset":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"menuItem":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"page":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"audience":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"custom":{"nullable":false,"type":"object"},"default":{"nullable":false,"type":"boolean"},"type":{"enum":["alarm","page","service"],"nullable":true,"type":"string"}}},"group":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"asset":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"menuItem":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"custom":{"nullable":false,"type":"object"}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"post":{"tags":["AgentPageLinkList"],"summary":"AgentPageLinkList","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"page":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"audience":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"group":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"custom":{"nullable":false,"type":"object"}},"required":["page","audience"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"patch":{"tags":["AgentPageLinkList"],"summary":"AgentPageLinkList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"page":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"audience":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"group":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"custom":{"nullable":false,"type":"object"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"delete":{"tags":["AgentPageLinkList"],"summary":"AgentPageLinkList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/agents/{agentId}/pages":{"get":{"tags":["AgentPageList"],"summary":"AgentPageList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"applicationType":{"enum":["sheet","card","report"],"nullable":false,"type":"string"},"company":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"group":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"draft":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"page":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"title":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"components":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"pageVersion":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"template":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"boundVersion":{"nullable":true,"type":"object","properties":{"template":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"number":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"\\d+","type":"string"},"mainPath":{"maxLength":255,"minLength":4,"nullable":false,"type":"string"},"notes":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"publishedOn":{"nullable":true,"type":"string","format":"date-time"},"createdOn":{"nullable":false,"type":"string","format":"date-time"},"createdBy":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}},"dimensions":{"oneOf":[{"type":"object","properties":{"type":{"enum":["sheet"],"nullable":false,"type":"string"},"left":{"maximum":11,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":71,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":12,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":72,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"mobileHeight":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"mobileOrder":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"mobileLeft":{"maximum":11,"nullable":true,"type":"integer","format":"int32"},"mobileCols":{"maximum":12,"minimum":1,"nullable":true,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]},{"type":"object","properties":{"type":{"enum":["card"],"nullable":false,"type":"string"},"height":{"maximum":65535,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}},"required":["type","height","order"]},{"type":"object","properties":{"type":{"enum":["report"],"nullable":false,"type":"string"},"left":{"maximum":7,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":15,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":8,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":16,"minimum":1,"nullable":false,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]},{"type":"object","properties":{"type":{"enum":["report-portrait"],"nullable":false,"type":"string"},"left":{"maximum":5,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":15,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":6,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":16,"minimum":1,"nullable":false,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]},{"type":"object","properties":{"type":{"enum":["report-landscape"],"nullable":false,"type":"string"},"left":{"maximum":7,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":10,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":8,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":11,"minimum":1,"nullable":false,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]}]},"inputs":{"maxLength":16777215,"minLength":0,"nullable":false,"type":"string"},"pagePage":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"pageVersion":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}}}}}},"previewAgent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"previewAsset":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"periodSpec":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"periodSelectorEnabled":{"nullable":false,"type":"boolean"},"defaultRefreshRate":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"createdOn":{"nullable":false,"type":"string","format":"date-time"},"createdBy":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"updatedOn":{"nullable":true,"type":"string","format":"date-time"},"updatedBy":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"pagePages":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"pageVersion":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}}}},"custom":{"nullable":false,"type":"object"}}},"published":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"page":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"title":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"components":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"pageVersion":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"template":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"boundVersion":{"nullable":true,"type":"object","properties":{"template":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"number":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"\\d+","type":"string"},"mainPath":{"maxLength":255,"minLength":4,"nullable":false,"type":"string"},"notes":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"publishedOn":{"nullable":true,"type":"string","format":"date-time"},"createdOn":{"nullable":false,"type":"string","format":"date-time"},"createdBy":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}},"dimensions":{"oneOf":[{"type":"object","properties":{"type":{"enum":["sheet"],"nullable":false,"type":"string"},"left":{"maximum":11,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":71,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":12,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":72,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"mobileHeight":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"mobileOrder":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"mobileLeft":{"maximum":11,"nullable":true,"type":"integer","format":"int32"},"mobileCols":{"maximum":12,"minimum":1,"nullable":true,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]},{"type":"object","properties":{"type":{"enum":["card"],"nullable":false,"type":"string"},"height":{"maximum":65535,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}},"required":["type","height","order"]},{"type":"object","properties":{"type":{"enum":["report"],"nullable":false,"type":"string"},"left":{"maximum":7,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":15,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":8,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":16,"minimum":1,"nullable":false,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]},{"type":"object","properties":{"type":{"enum":["report-portrait"],"nullable":false,"type":"string"},"left":{"maximum":5,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":15,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":6,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":16,"minimum":1,"nullable":false,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]},{"type":"object","properties":{"type":{"enum":["report-landscape"],"nullable":false,"type":"string"},"left":{"maximum":7,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":10,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":8,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":11,"minimum":1,"nullable":false,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]}]},"inputs":{"maxLength":16777215,"minLength":0,"nullable":false,"type":"string"},"pagePage":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"pageVersion":{"nullable":false,"type":"object"},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}}}}}},"previewAgent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"previewAsset":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"periodSpec":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"periodSelectorEnabled":{"nullable":false,"type":"boolean"},"defaultRefreshRate":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"createdOn":{"nullable":false,"type":"string","format":"date-time"},"createdBy":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"updatedOn":{"nullable":true,"type":"string","format":"date-time"},"updatedBy":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"pagePages":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"pageVersion":{"nullable":false,"type":"object"},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}}}},"custom":{"nullable":false,"type":"object"}}},"default":{"nullable":false,"type":"boolean"},"static":{"nullable":false,"type":"boolean"},"orientation":{"enum":["portrait","landscape"],"nullable":true,"type":"string"},"labels":{"type":"array","items":{"nullable":false,"type":"object","properties":{"color":{"maxLength":7,"minLength":6,"nullable":false,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"company":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}},"custom":{"nullable":false,"type":"object"}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/agents/{agentId}/pull-code":{"get":{"tags":["AgentPullCode"],"summary":"AgentPullCode","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"pullCode":{"maxLength":11,"minLength":11,"nullable":true,"pattern":"[1-9]{3}-[B-DF-HJ-NP-TV-Z]{3}-[1-9]{3}","type":"string"},"pullCodeGeneratedOn":{"nullable":true,"type":"string","format":"date-time"}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"post":{"tags":["AgentPullCode"],"summary":"AgentPullCode","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"pullCode":{"maxLength":11,"minLength":11,"nullable":true,"pattern":"[1-9]{3}-[B-DF-HJ-NP-TV-Z]{3}-[1-9]{3}","type":"string"},"pullCodeGeneratedOn":{"nullable":true,"type":"string","format":"date-time"}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"delete":{"tags":["AgentPullCode"],"summary":"AgentPullCode","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/agents/{agentId}/report/queue":{"post":{"tags":["AgentQueueReportList"],"summary":"AgentQueueReportList","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"report":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"sendTo":{"type":"array","items":{"maxLength":254,"minLength":6,"nullable":false,"pattern":"^(?=.{1,254}$)(?=.{1,64}@)[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+(?:\\.[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+)*@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$","type":"string"}},"timeZone":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"start":{"nullable":false,"type":"string","format":"date-time"},"end":{"nullable":false,"type":"string","format":"date-time"},"message":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"}},"required":["report","sendTo","timeZone","start","end"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/agents/{agentId}/reboot":{"post":{"tags":["AgentReboot"],"summary":"AgentReboot","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/agent-registration-profiles/{publicId}":{"get":{"tags":["AgentRegistrationProfile"],"summary":"AgentRegistrationProfile","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":24,"minLength":24,"nullable":false,"pattern":"(\\d{4}-){4}\\d{4}","type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"agentActivationName":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"template":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"}}},"memberships":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"profile":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"group":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"type":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"order":{"maximum":9223372036854776000,"minimum":-9223372036854776000,"nullable":false,"type":"integer","format":"int32"},"color":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"custom":{"nullable":false,"type":"object"}}}}}}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"patch":{"tags":["AgentRegistrationProfile"],"summary":"AgentRegistrationProfile","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"agentActivationName":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"template":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}}}},"security":[{"bearerToken":[]}]},"delete":{"tags":["AgentRegistrationProfile"],"summary":"AgentRegistrationProfile","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/agent-registration-profiles":{"get":{"tags":["AgentRegistrationProfileList"],"summary":"AgentRegistrationProfileList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":24,"minLength":24,"nullable":false,"pattern":"(\\d{4}-){4}\\d{4}","type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"agentActivationName":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"template":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"}}},"memberships":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"profile":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"group":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"type":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"order":{"maximum":9223372036854776000,"minimum":-9223372036854776000,"nullable":false,"type":"integer","format":"int32"},"color":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"custom":{"nullable":false,"type":"object"}}}}}}}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"}],"security":[{"bearerToken":[]}]},"post":{"tags":["AgentRegistrationProfileList"],"summary":"AgentRegistrationProfileList","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"agentActivationName":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"template":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"memberships":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"patch":{"tags":["AgentRegistrationProfileList"],"summary":"AgentRegistrationProfileList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":24,"minLength":24,"nullable":false,"pattern":"(\\d{4}-){4}\\d{4}","type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"agentActivationName":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"template":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"delete":{"tags":["AgentRegistrationProfileList"],"summary":"AgentRegistrationProfileList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":24,"minLength":24,"nullable":false,"pattern":"(\\d{4}-){4}\\d{4}","type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/agent-registration-profiles/memberships/{publicId}":{"get":{"tags":["AgentRegistrationProfileMembership"],"summary":"AgentRegistrationProfileMembership","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"profile":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"group":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"type":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"order":{"maximum":9223372036854776000,"minimum":-9223372036854776000,"nullable":false,"type":"integer","format":"int32"},"color":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"custom":{"nullable":false,"type":"object"}}}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"patch":{"tags":["AgentRegistrationProfileMembership"],"summary":"AgentRegistrationProfileMembership","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"profile":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"group":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}},"required":["profile","group"]}}}},"security":[{"bearerToken":[]}]},"delete":{"tags":["AgentRegistrationProfileMembership"],"summary":"AgentRegistrationProfileMembership","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/agent-registration-profiles/memberships":{"get":{"tags":["AgentRegistrationProfileMembershipList"],"summary":"AgentRegistrationProfileMembershipList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"profile":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"group":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"type":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"order":{"maximum":9223372036854776000,"minimum":-9223372036854776000,"nullable":false,"type":"integer","format":"int32"},"color":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"custom":{"nullable":false,"type":"object"}}}}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"}],"security":[{"bearerToken":[]}]},"post":{"tags":["AgentRegistrationProfileMembershipList"],"summary":"AgentRegistrationProfileMembershipList","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"profile":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"group":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}},"required":["profile","group"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"patch":{"tags":["AgentRegistrationProfileMembershipList"],"summary":"AgentRegistrationProfileMembershipList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"profile":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"group":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}},"required":["publicId","profile","group"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"delete":{"tags":["AgentRegistrationProfileMembershipList"],"summary":"AgentRegistrationProfileMembershipList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/agents/{agentId}/report-schedules/{publicId}":{"get":{"tags":["AgentReportSchedule"],"summary":"AgentReportSchedule","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"asset":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"report":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"start":{"nullable":false,"type":"string","format":"date-time"},"timeZone":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"recurrence":{"oneOf":[{"type":"object","properties":{"frequency":{"enum":["weekly"],"nullable":false,"type":"string"},"interval":{"maximum":127,"minimum":-128,"nullable":false,"type":"integer","format":"int32"},"monday":{"nullable":false,"type":"boolean"},"tuesday":{"nullable":false,"type":"boolean"},"wednesday":{"nullable":false,"type":"boolean"},"thursday":{"nullable":false,"type":"boolean"},"friday":{"nullable":false,"type":"boolean"},"saturday":{"nullable":false,"type":"boolean"},"sunday":{"nullable":false,"type":"boolean"}},"required":["frequency","interval"]},{"type":"object","properties":{"frequency":{"enum":["monthly"],"nullable":false,"type":"string"},"interval":{"maximum":127,"minimum":-128,"nullable":false,"type":"integer","format":"int32"},"occurrence":{"maximum":127,"minimum":-128,"nullable":false,"type":"integer","format":"int32"},"monday":{"nullable":false,"type":"boolean"},"tuesday":{"nullable":false,"type":"boolean"},"wednesday":{"nullable":false,"type":"boolean"},"thursday":{"nullable":false,"type":"boolean"},"friday":{"nullable":false,"type":"boolean"},"saturday":{"nullable":false,"type":"boolean"},"sunday":{"nullable":false,"type":"boolean"}},"required":["frequency","interval","occurrence"]}]},"deliveryTime":{"nullable":false,"type":"string"}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"patch":{"tags":["AgentReportSchedule"],"summary":"AgentReportSchedule","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"timeZone":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"recurrence":{"oneOf":[{"type":"object","properties":{"frequency":{"enum":["weekly"],"nullable":false,"type":"string"},"interval":{"maximum":127,"minimum":-128,"nullable":false,"type":"integer","format":"int32"},"monday":{"nullable":false,"type":"boolean"},"tuesday":{"nullable":false,"type":"boolean"},"wednesday":{"nullable":false,"type":"boolean"},"thursday":{"nullable":false,"type":"boolean"},"friday":{"nullable":false,"type":"boolean"},"saturday":{"nullable":false,"type":"boolean"},"sunday":{"nullable":false,"type":"boolean"}},"required":["frequency","interval"]},{"type":"object","properties":{"frequency":{"enum":["monthly"],"nullable":false,"type":"string"},"interval":{"maximum":127,"minimum":-128,"nullable":false,"type":"integer","format":"int32"},"occurrence":{"maximum":127,"minimum":-128,"nullable":false,"type":"integer","format":"int32"},"monday":{"nullable":false,"type":"boolean"},"tuesday":{"nullable":false,"type":"boolean"},"wednesday":{"nullable":false,"type":"boolean"},"thursday":{"nullable":false,"type":"boolean"},"friday":{"nullable":false,"type":"boolean"},"saturday":{"nullable":false,"type":"boolean"},"sunday":{"nullable":false,"type":"boolean"}},"required":["frequency","interval","occurrence"]}]},"deliveryTime":{"nullable":false,"type":"string"},"start":{"nullable":false,"type":"string","format":"date-time"}}}}}},"security":[{"bearerToken":[]}]},"delete":{"tags":["AgentReportSchedule"],"summary":"AgentReportSchedule","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/agents/{agentId}/report-schedules":{"get":{"tags":["AgentReportScheduleList"],"summary":"AgentReportScheduleList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"asset":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"report":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"start":{"nullable":false,"type":"string","format":"date-time"},"timeZone":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"recurrence":{"oneOf":[{"type":"object","properties":{"frequency":{"enum":["weekly"],"nullable":false,"type":"string"},"interval":{"maximum":127,"minimum":-128,"nullable":false,"type":"integer","format":"int32"},"monday":{"nullable":false,"type":"boolean"},"tuesday":{"nullable":false,"type":"boolean"},"wednesday":{"nullable":false,"type":"boolean"},"thursday":{"nullable":false,"type":"boolean"},"friday":{"nullable":false,"type":"boolean"},"saturday":{"nullable":false,"type":"boolean"},"sunday":{"nullable":false,"type":"boolean"}},"required":["frequency","interval"]},{"type":"object","properties":{"frequency":{"enum":["monthly"],"nullable":false,"type":"string"},"interval":{"maximum":127,"minimum":-128,"nullable":false,"type":"integer","format":"int32"},"occurrence":{"maximum":127,"minimum":-128,"nullable":false,"type":"integer","format":"int32"},"monday":{"nullable":false,"type":"boolean"},"tuesday":{"nullable":false,"type":"boolean"},"wednesday":{"nullable":false,"type":"boolean"},"thursday":{"nullable":false,"type":"boolean"},"friday":{"nullable":false,"type":"boolean"},"saturday":{"nullable":false,"type":"boolean"},"sunday":{"nullable":false,"type":"boolean"}},"required":["frequency","interval","occurrence"]}]},"deliveryTime":{"nullable":false,"type":"string"}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"post":{"tags":["AgentReportScheduleList"],"summary":"AgentReportScheduleList","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"report":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"start":{"nullable":false,"type":"string","format":"date-time"},"timeZone":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"recurrence":{"oneOf":[{"type":"object","properties":{"frequency":{"enum":["weekly"],"nullable":false,"type":"string"},"interval":{"maximum":127,"minimum":-128,"nullable":false,"type":"integer","format":"int32"},"monday":{"nullable":false,"type":"boolean"},"tuesday":{"nullable":false,"type":"boolean"},"wednesday":{"nullable":false,"type":"boolean"},"thursday":{"nullable":false,"type":"boolean"},"friday":{"nullable":false,"type":"boolean"},"saturday":{"nullable":false,"type":"boolean"},"sunday":{"nullable":false,"type":"boolean"}},"required":["frequency","interval"]},{"type":"object","properties":{"frequency":{"enum":["monthly"],"nullable":false,"type":"string"},"interval":{"maximum":127,"minimum":-128,"nullable":false,"type":"integer","format":"int32"},"occurrence":{"maximum":127,"minimum":-128,"nullable":false,"type":"integer","format":"int32"},"monday":{"nullable":false,"type":"boolean"},"tuesday":{"nullable":false,"type":"boolean"},"wednesday":{"nullable":false,"type":"boolean"},"thursday":{"nullable":false,"type":"boolean"},"friday":{"nullable":false,"type":"boolean"},"saturday":{"nullable":false,"type":"boolean"},"sunday":{"nullable":false,"type":"boolean"}},"required":["frequency","interval","occurrence"]}]},"deliveryTime":{"nullable":false,"type":"string"}},"required":["report","start","timeZone","recurrence","deliveryTime"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"patch":{"tags":["AgentReportScheduleList"],"summary":"AgentReportScheduleList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"timeZone":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"recurrence":{"oneOf":[{"type":"object","properties":{"frequency":{"enum":["weekly"],"nullable":false,"type":"string"},"interval":{"maximum":127,"minimum":-128,"nullable":false,"type":"integer","format":"int32"},"monday":{"nullable":false,"type":"boolean"},"tuesday":{"nullable":false,"type":"boolean"},"wednesday":{"nullable":false,"type":"boolean"},"thursday":{"nullable":false,"type":"boolean"},"friday":{"nullable":false,"type":"boolean"},"saturday":{"nullable":false,"type":"boolean"},"sunday":{"nullable":false,"type":"boolean"}},"required":["frequency","interval"]},{"type":"object","properties":{"frequency":{"enum":["monthly"],"nullable":false,"type":"string"},"interval":{"maximum":127,"minimum":-128,"nullable":false,"type":"integer","format":"int32"},"occurrence":{"maximum":127,"minimum":-128,"nullable":false,"type":"integer","format":"int32"},"monday":{"nullable":false,"type":"boolean"},"tuesday":{"nullable":false,"type":"boolean"},"wednesday":{"nullable":false,"type":"boolean"},"thursday":{"nullable":false,"type":"boolean"},"friday":{"nullable":false,"type":"boolean"},"saturday":{"nullable":false,"type":"boolean"},"sunday":{"nullable":false,"type":"boolean"}},"required":["frequency","interval","occurrence"]}]},"deliveryTime":{"nullable":false,"type":"string"},"start":{"nullable":false,"type":"string","format":"date-time"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"delete":{"tags":["AgentReportScheduleList"],"summary":"AgentReportScheduleList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/agents/{agentId}/router-additional-subnets/{publicId}":{"get":{"tags":["AgentRouterAdditionalSubnet"],"summary":"AgentRouterAdditionalSubnet","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"networkAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"networkMask":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"gatewayAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"patch":{"tags":["AgentRouterAdditionalSubnet"],"summary":"AgentRouterAdditionalSubnet","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"networkAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"networkMask":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"gatewayAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}}}}}},"security":[{"bearerToken":[]}]},"delete":{"tags":["AgentRouterAdditionalSubnet"],"summary":"AgentRouterAdditionalSubnet","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/agents/{agentId}/router-additional-subnets":{"get":{"tags":["AgentRouterAdditionalSubnetList"],"summary":"AgentRouterAdditionalSubnetList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"networkAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"networkMask":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"gatewayAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"post":{"tags":["AgentRouterAdditionalSubnetList"],"summary":"AgentRouterAdditionalSubnetList","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"networkAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"networkMask":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"gatewayAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}},"required":["networkAddress","networkMask","gatewayAddress"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"patch":{"tags":["AgentRouterAdditionalSubnetList"],"summary":"AgentRouterAdditionalSubnetList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"networkAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"networkMask":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"gatewayAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"delete":{"tags":["AgentRouterAdditionalSubnetList"],"summary":"AgentRouterAdditionalSubnetList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/agents/{agentId}/router-display-config":{"patch":{"tags":["AgentRouterDisplayConfig"],"summary":"AgentRouterDisplayConfig","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"lockEnabled":{"nullable":false,"type":"boolean"},"lockCode":{"maxLength":4,"minLength":4,"nullable":true,"pattern":"[0-9]+","type":"string"}}}}}},"security":[{"bearerToken":[]}]}},"/agents/{agentId}/router-lan-config":{"patch":{"tags":["AgentRouterLanConfig"],"summary":"AgentRouterLanConfig","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"ipAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"netMask":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"network":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"dhcpServerEnabled":{"nullable":false,"type":"boolean"},"dhcpServerRangeFrom":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"dhcpServerRangeTo":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"gatewayLessRouting":{"nullable":false,"type":"boolean"},"forwardLanWan":{"enum":["neither","public","private","both"],"nullable":false,"type":"string"},"forwardLanWan2":{"enum":["neither","public","private","both"],"nullable":false,"type":"string"},"wlanEnable":{"nullable":true,"type":"boolean"},"wlanSsid":{"maxLength":32,"minLength":0,"nullable":true,"type":"string"},"wlanKey":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"wlanChannel":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"bacnetBbmd":{"type":"array","items":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}},"udpBroadcastRelayPort":{"type":"array","items":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}}}}}}},"security":[{"bearerToken":[]}]}},"/agents/{agentId}/router-lan-wan-access-rules/{publicId}":{"get":{"tags":["AgentRouterLanWanAccessRule"],"summary":"AgentRouterLanWanAccessRule","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"sourceIpAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"sourceMacAddress":{"maxLength":17,"minLength":17,"nullable":true,"pattern":"[0-9a-fA-F]{2}(:[0-9a-fA-F]{2}){5}","type":"string"},"destinationPort":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"destinationIpAddress":{"maxLength":19,"minLength":7,"nullable":true,"pattern":"\\d{1,3}(\\.\\d{1,3}){3}(\\/\\d{1,3})?","type":"string"},"protocol":{"enum":["all","tcp","udp","icmp","ah","ax.25","dccp","ddp","egp","eigrp","encap","esp","etherip","fc","ggp","gre","hmp","idpr-cmtp","idrp","igmp","igp","ipcomp","ipencap","ipip","ipv6","ipv6-frag","ipv6-icmp","ipv6-nonxt","ipv6-opts","ipv6-route","isis","iso-tp4","l2tp","ospf","pim","pup","rdp","rspf","rsvp","sctp","skip","st","vmtp","vrrp","xns-idp","xtp"],"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"patch":{"tags":["AgentRouterLanWanAccessRule"],"summary":"AgentRouterLanWanAccessRule","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"sourceIpAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"sourceMacAddress":{"maxLength":17,"minLength":17,"nullable":true,"pattern":"[0-9a-fA-F]{2}(:[0-9a-fA-F]{2}){5}","type":"string"},"destinationPort":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"protocol":{"enum":["all","tcp","udp","icmp","ah","ax.25","dccp","ddp","egp","eigrp","encap","esp","etherip","fc","ggp","gre","hmp","idpr-cmtp","idrp","igmp","igp","ipcomp","ipencap","ipip","ipv6","ipv6-frag","ipv6-icmp","ipv6-nonxt","ipv6-opts","ipv6-route","isis","iso-tp4","l2tp","ospf","pim","pup","rdp","rspf","rsvp","sctp","skip","st","vmtp","vrrp","xns-idp","xtp"],"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"}}}}}},"security":[{"bearerToken":[]}]},"delete":{"tags":["AgentRouterLanWanAccessRule"],"summary":"AgentRouterLanWanAccessRule","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/agents/{agentId}/router-lan-wan-access-rules":{"get":{"tags":["AgentRouterLanWanAccessRuleList"],"summary":"AgentRouterLanWanAccessRuleList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"sourceIpAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"sourceMacAddress":{"maxLength":17,"minLength":17,"nullable":true,"pattern":"[0-9a-fA-F]{2}(:[0-9a-fA-F]{2}){5}","type":"string"},"destinationPort":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"destinationIpAddress":{"maxLength":19,"minLength":7,"nullable":true,"pattern":"\\d{1,3}(\\.\\d{1,3}){3}(\\/\\d{1,3})?","type":"string"},"protocol":{"enum":["all","tcp","udp","icmp","ah","ax.25","dccp","ddp","egp","eigrp","encap","esp","etherip","fc","ggp","gre","hmp","idpr-cmtp","idrp","igmp","igp","ipcomp","ipencap","ipip","ipv6","ipv6-frag","ipv6-icmp","ipv6-nonxt","ipv6-opts","ipv6-route","isis","iso-tp4","l2tp","ospf","pim","pup","rdp","rspf","rsvp","sctp","skip","st","vmtp","vrrp","xns-idp","xtp"],"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"patch":{"tags":["AgentRouterLanWanAccessRuleList"],"summary":"AgentRouterLanWanAccessRuleList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"sourceIpAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"sourceMacAddress":{"maxLength":17,"minLength":17,"nullable":true,"pattern":"[0-9a-fA-F]{2}(:[0-9a-fA-F]{2}){5}","type":"string"},"destinationPort":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"protocol":{"enum":["all","tcp","udp","icmp","ah","ax.25","dccp","ddp","egp","eigrp","encap","esp","etherip","fc","ggp","gre","hmp","idpr-cmtp","idrp","igmp","igp","ipcomp","ipencap","ipip","ipv6","ipv6-frag","ipv6-icmp","ipv6-nonxt","ipv6-opts","ipv6-route","isis","iso-tp4","l2tp","ospf","pim","pup","rdp","rspf","rsvp","sctp","skip","st","vmtp","vrrp","xns-idp","xtp"],"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"post":{"tags":["AgentRouterLanWanAccessRuleList"],"summary":"AgentRouterLanWanAccessRuleList","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"sourceIpAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"sourceMacAddress":{"maxLength":17,"minLength":17,"nullable":true,"pattern":"[0-9a-fA-F]{2}(:[0-9a-fA-F]{2}){5}","type":"string"},"destinationPort":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"protocol":{"enum":["all","tcp","udp","icmp","ah","ax.25","dccp","ddp","egp","eigrp","encap","esp","etherip","fc","ggp","gre","hmp","idpr-cmtp","idrp","igmp","igp","ipcomp","ipencap","ipip","ipv6","ipv6-frag","ipv6-icmp","ipv6-nonxt","ipv6-opts","ipv6-route","isis","iso-tp4","l2tp","ospf","pim","pup","rdp","rspf","rsvp","sctp","skip","st","vmtp","vrrp","xns-idp","xtp"],"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"}},"required":["protocol"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"delete":{"tags":["AgentRouterLanWanAccessRuleList"],"summary":"AgentRouterLanWanAccessRuleList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/agents/{agentId}/router-ntp-servers/{publicId}":{"get":{"tags":["AgentRouterNtpServer"],"summary":"AgentRouterNtpServer","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"server":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"patch":{"tags":["AgentRouterNtpServer"],"summary":"AgentRouterNtpServer","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"server":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}},"required":["server"]}}}},"security":[{"bearerToken":[]}]},"delete":{"tags":["AgentRouterNtpServer"],"summary":"AgentRouterNtpServer","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/agents/{agentId}/router-ntp-servers":{"get":{"tags":["AgentRouterNtpServerList"],"summary":"AgentRouterNtpServerList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"server":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"post":{"tags":["AgentRouterNtpServerList"],"summary":"AgentRouterNtpServerList","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"server":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}},"required":["server"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"patch":{"tags":["AgentRouterNtpServerList"],"summary":"AgentRouterNtpServerList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"server":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}},"required":["publicId","server"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"delete":{"tags":["AgentRouterNtpServerList"],"summary":"AgentRouterNtpServerList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"put":{"tags":["AgentRouterNtpServerList"],"summary":"AgentRouterNtpServerList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"servers":{"type":"array","items":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"required":["servers"]}}}},"security":[{"bearerToken":[]}]}},"/agents/{agentId}/router-one-to-one-nat-rules/{publicId}":{"get":{"tags":["AgentRouterOneToOneNatRule"],"summary":"AgentRouterOneToOneNatRule","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"type":{"enum":["wan","wlan","vpn"],"nullable":false,"type":"string"},"virtualIpAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"destinationIpAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"protocol":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"port":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"sourceIpAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"patch":{"tags":["AgentRouterOneToOneNatRule"],"summary":"AgentRouterOneToOneNatRule","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"enum":["wan","wlan","vpn"],"nullable":false,"type":"string"},"virtualIpAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"destinationIpAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"protocol":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"port":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"sourceIpAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"}}}}}},"security":[{"bearerToken":[]}]},"delete":{"tags":["AgentRouterOneToOneNatRule"],"summary":"AgentRouterOneToOneNatRule","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/agents/{agentId}/router-one-to-one-nat-rules":{"get":{"tags":["AgentRouterOneToOneNatRuleList"],"summary":"AgentRouterOneToOneNatRuleList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"type":{"enum":["wan","wlan","vpn"],"nullable":false,"type":"string"},"virtualIpAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"destinationIpAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"protocol":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"port":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"sourceIpAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"post":{"tags":["AgentRouterOneToOneNatRuleList"],"summary":"AgentRouterOneToOneNatRuleList","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"type":{"enum":["wan","wlan","vpn"],"nullable":false,"type":"string"},"virtualIpAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"destinationIpAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"protocol":{"enum":["all","tcp","udp","icmp","ah","ax.25","dccp","ddp","egp","eigrp","encap","esp","etherip","fc","ggp","gre","hmp","idpr-cmtp","idrp","igmp","igp","ipcomp","ipencap","ipip","ipv6","ipv6-frag","ipv6-icmp","ipv6-nonxt","ipv6-opts","ipv6-route","isis","iso-tp4","l2tp","ospf","pim","pup","rdp","rspf","rsvp","sctp","skip","st","vmtp","vrrp","xns-idp","xtp"],"nullable":false,"type":"string"},"port":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"sourceIpAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"}},"required":["type","virtualIpAddress","destinationIpAddress","protocol"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"patch":{"tags":["AgentRouterOneToOneNatRuleList"],"summary":"AgentRouterOneToOneNatRuleList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"type":{"enum":["wan","wlan","vpn"],"nullable":false,"type":"string"},"virtualIpAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"destinationIpAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"protocol":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"port":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"sourceIpAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"delete":{"tags":["AgentRouterOneToOneNatRuleList"],"summary":"AgentRouterOneToOneNatRuleList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/agents/{agentId}/router-port-forwards/{publicId}":{"get":{"tags":["AgentRouterPortForward"],"summary":"AgentRouterPortForward","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"interface":{"enum":["VPN","WAN","WAN2"],"nullable":false,"type":"string"},"targetIpAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"targetPort":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"externalPort":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"patch":{"tags":["AgentRouterPortForward"],"summary":"AgentRouterPortForward","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"targetIpAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"targetPort":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"externalPort":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}}}}}},"security":[{"bearerToken":[]}]},"delete":{"tags":["AgentRouterPortForward"],"summary":"AgentRouterPortForward","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/agents/{agentId}/router-port-forwards":{"get":{"tags":["AgentRouterPortForwardList"],"summary":"AgentRouterPortForwardList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"interface":{"enum":["VPN","WAN","WAN2"],"nullable":false,"type":"string"},"targetIpAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"targetPort":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"externalPort":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"post":{"tags":["AgentRouterPortForwardList"],"summary":"AgentRouterPortForwardList","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"targetIpAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"targetPort":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"externalPort":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"interface":{"enum":["WAN","WAN2"],"nullable":false,"type":"string"}},"required":["targetIpAddress","targetPort","externalPort"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"patch":{"tags":["AgentRouterPortForwardList"],"summary":"AgentRouterPortForwardList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"targetIpAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"targetPort":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"externalPort":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"delete":{"tags":["AgentRouterPortForwardList"],"summary":"AgentRouterPortForwardList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/agents/{agentId}/router-vpn-access-rules/{publicId}":{"get":{"tags":["AgentRouterVpnAccessRule"],"summary":"AgentRouterVpnAccessRule","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"audience":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"ipAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"netMask":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"patch":{"tags":["AgentRouterVpnAccessRule"],"summary":"AgentRouterVpnAccessRule","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"audience":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"ipAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"netMask":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}}}}}},"security":[{"bearerToken":[]}]},"delete":{"tags":["AgentRouterVpnAccessRule"],"summary":"AgentRouterVpnAccessRule","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/agents/{agentId}/router-vpn-access-rules":{"get":{"tags":["AgentRouterVpnAccessRuleList"],"summary":"AgentRouterVpnAccessRuleList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"audience":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"ipAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"netMask":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"post":{"tags":["AgentRouterVpnAccessRuleList"],"summary":"AgentRouterVpnAccessRuleList","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"audience":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"ipAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"netMask":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}},"required":["audience","ipAddress","netMask"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"patch":{"tags":["AgentRouterVpnAccessRuleList"],"summary":"AgentRouterVpnAccessRuleList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"audience":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"ipAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"netMask":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"delete":{"tags":["AgentRouterVpnAccessRuleList"],"summary":"AgentRouterVpnAccessRuleList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/agents/{agentId}/router-vpn-config":{"patch":{"tags":["AgentRouterVpnConfig"],"summary":"AgentRouterVpnConfig","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"sourceNatEnabled":{"nullable":false,"type":"boolean"}}}}}},"security":[{"bearerToken":[]}]}},"/agents/{agentId}/router-wan-config":{"patch":{"tags":["AgentRouterWanConfig"],"summary":"AgentRouterWanConfig","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"multiwanPolicy":{"enum":["eth_cell_wifi","cell_eth_wifi","eth_wifi_cell","wifi_eth_cell","cell_wifi_eth","wifi_cell_eth"],"nullable":true,"type":"string"},"ipUseDhcp":{"nullable":true,"type":"boolean"},"ipAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"ipGateway":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"ipNetMask":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"dnsServers":{"type":"array","items":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}},"dnsRebindProtectionEnabled":{"nullable":true,"type":"boolean"},"cellularApn":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"cellularPincode":{"maxLength":8,"minLength":0,"nullable":true,"type":"string"},"cellularMtu":{"maximum":1500,"minimum":576,"nullable":true,"type":"integer","format":"int32"},"digitalInputMode":{"enum":["disable_vpn_high","disable_vpn_low","disable_wan_high","disable_wan_low"],"nullable":true,"type":"string"},"wanTrackInterval":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"wanTrackIps":{"type":"array","items":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}},"wlanTrackInterval":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"wlanTrackIps":{"type":"array","items":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}},"cellularTrackInterval":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"cellularTrackIps":{"type":"array","items":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}},"httpProxyAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"httpProxyPort":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"httpProxyAuthentication":{"enum":["none","basic","ntlm"],"nullable":true,"type":"string"},"httpProxyUsername":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"httpProxyIsSocks5":{"nullable":true,"type":"boolean"}}}}}},"security":[{"bearerToken":[]}]}},"/agents/{agentId}/router-wan-config/cellular":{"post":{"tags":["AgentRouterWanConfigCellularPush"],"summary":"AgentRouterWanConfigCellularPush","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"cellularApn":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"cellularPincode":{"maxLength":8,"minLength":0,"nullable":true,"type":"string"},"cellularMtu":{"maximum":1500,"minimum":576,"nullable":true,"type":"integer","format":"int32"},"cellularUsername":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"cellularPassword":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"}},"required":["cellularApn"]}}}},"security":[{"bearerToken":[]}]},"delete":{"tags":["AgentRouterWanConfigCellularPush"],"summary":"AgentRouterWanConfigCellularPush","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/agents/{agentId}/router-wan-config/wlan":{"post":{"tags":["AgentRouterWanConfigWlanPush"],"summary":"AgentRouterWanConfigWlanPush","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"wlanSsid":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"wlanKey":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"wlanIpUseDhcp":{"nullable":true,"type":"boolean"},"wlanIpAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"wlanIpGateway":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"wlanIpNetMask":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"wlanDnsServers":{"type":"array","items":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}}},"required":["wlanSsid"]}}}},"security":[{"bearerToken":[]}]},"delete":{"tags":["AgentRouterWanConfigWlanPush"],"summary":"AgentRouterWanConfigWlanPush","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/agents/{agentId}/servers/{publicId}":{"get":{"tags":["AgentServer"],"summary":"AgentServer","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"type":{"enum":["http","rdp","rtsp","ssh","vnc","websocket"],"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"port":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"username":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"password":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"hasPassword":{"nullable":false,"type":"boolean"},"authDomain":{"maxLength":253,"minLength":4,"nullable":true,"pattern":".+(\\..[^.]+)","type":"string"},"landingPage":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"connectionQuality":{"enum":["low","normal","high"],"nullable":true,"type":"string"},"readOnly":{"nullable":true,"type":"boolean"},"vncRightClickOnTouchHold":{"nullable":false,"type":"boolean"},"vncEncoding":{"enum":["copyrect","corre","hextile","raw","rre","tight","ultra","ultrazip","zlib","zlibhex","zrle","zywrle"],"nullable":true,"type":"string"},"useSsl":{"nullable":false,"type":"boolean"},"visibleInMobileApp":{"nullable":false,"type":"boolean"},"visibleOnWeb":{"nullable":false,"type":"boolean"},"httpAuthenticationType":{"enum":["ntlm","basic","digest"],"nullable":true,"type":"string"},"recordSessions":{"nullable":true,"type":"boolean"},"audience":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"requireAccessApproval":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"device":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"serviceGroup":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"template":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"type":{"enum":["http","rdp","rtsp","ssh","vnc","websocket"],"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"port":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"username":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"password":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"hasPassword":{"nullable":false,"type":"boolean"},"authDomain":{"maxLength":253,"minLength":4,"nullable":true,"pattern":".+(\\..[^.]+)","type":"string"},"landingPage":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"connectionQuality":{"enum":["low","normal","high"],"nullable":true,"type":"string"},"readOnly":{"nullable":true,"type":"boolean"},"vncRightClickOnTouchHold":{"nullable":false,"type":"boolean"},"vncEncoding":{"enum":["copyrect","corre","hextile","raw","rre","tight","ultra","ultrazip","zlib","zlibhex","zrle","zywrle"],"nullable":true,"type":"string"},"useSsl":{"nullable":false,"type":"boolean"},"visibleInMobileApp":{"nullable":false,"type":"boolean"},"visibleOnWeb":{"nullable":false,"type":"boolean"},"httpAuthenticationType":{"enum":["ntlm","basic","digest"],"nullable":true,"type":"string"},"recordSessions":{"nullable":true,"type":"boolean"},"audience":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"requireAccessApproval":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"patch":{"tags":["AgentServer"],"summary":"AgentServer","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"device":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"serviceGroup":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"port":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"username":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"password":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"authDomain":{"maxLength":253,"minLength":4,"nullable":true,"pattern":".+(\\..[^.]+)","type":"string"},"landingPage":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"connectionQuality":{"enum":["low","normal","high"],"nullable":true,"type":"string"},"readOnly":{"nullable":true,"type":"boolean"},"vncRightClickOnTouchHold":{"nullable":false,"type":"boolean"},"vncEncoding":{"enum":["copyrect","corre","hextile","raw","rre","tight","ultra","ultrazip","zlib","zlibhex","zrle","zywrle"],"nullable":true,"type":"string"},"useSsl":{"nullable":false,"type":"boolean"},"visibleInMobileApp":{"nullable":false,"type":"boolean"},"visibleOnWeb":{"nullable":false,"type":"boolean"},"httpAuthenticationType":{"enum":["ntlm","basic","digest"],"nullable":true,"type":"string"},"recordSessions":{"nullable":true,"type":"boolean"},"audience":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"requireAccessApproval":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"}}}}}},"security":[{"bearerToken":[]}]},"delete":{"tags":["AgentServer"],"summary":"AgentServer","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/agents/{agentId}/servers/from-template":{"post":{"tags":["AgentServerFromTemplateList"],"summary":"AgentServerFromTemplateList","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"template":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"device":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"audience":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}},"required":["template","device","audience"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/agents/{agentId}/servers":{"get":{"tags":["AgentServerList"],"summary":"AgentServerList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"type":{"enum":["http","rdp","rtsp","ssh","vnc","websocket"],"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"port":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"username":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"password":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"hasPassword":{"nullable":false,"type":"boolean"},"authDomain":{"maxLength":253,"minLength":4,"nullable":true,"pattern":".+(\\..[^.]+)","type":"string"},"landingPage":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"connectionQuality":{"enum":["low","normal","high"],"nullable":true,"type":"string"},"readOnly":{"nullable":true,"type":"boolean"},"vncRightClickOnTouchHold":{"nullable":false,"type":"boolean"},"vncEncoding":{"enum":["copyrect","corre","hextile","raw","rre","tight","ultra","ultrazip","zlib","zlibhex","zrle","zywrle"],"nullable":true,"type":"string"},"useSsl":{"nullable":false,"type":"boolean"},"visibleInMobileApp":{"nullable":false,"type":"boolean"},"visibleOnWeb":{"nullable":false,"type":"boolean"},"httpAuthenticationType":{"enum":["ntlm","basic","digest"],"nullable":true,"type":"string"},"recordSessions":{"nullable":true,"type":"boolean"},"audience":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"requireAccessApproval":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"device":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"serviceGroup":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"template":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"type":{"enum":["http","rdp","rtsp","ssh","vnc","websocket"],"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"port":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"username":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"password":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"hasPassword":{"nullable":false,"type":"boolean"},"authDomain":{"maxLength":253,"minLength":4,"nullable":true,"pattern":".+(\\..[^.]+)","type":"string"},"landingPage":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"connectionQuality":{"enum":["low","normal","high"],"nullable":true,"type":"string"},"readOnly":{"nullable":true,"type":"boolean"},"vncRightClickOnTouchHold":{"nullable":false,"type":"boolean"},"vncEncoding":{"enum":["copyrect","corre","hextile","raw","rre","tight","ultra","ultrazip","zlib","zlibhex","zrle","zywrle"],"nullable":true,"type":"string"},"useSsl":{"nullable":false,"type":"boolean"},"visibleInMobileApp":{"nullable":false,"type":"boolean"},"visibleOnWeb":{"nullable":false,"type":"boolean"},"httpAuthenticationType":{"enum":["ntlm","basic","digest"],"nullable":true,"type":"string"},"recordSessions":{"nullable":true,"type":"boolean"},"audience":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"requireAccessApproval":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"}}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"post":{"tags":["AgentServerList"],"summary":"AgentServerList","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"type":{"enum":["http","rdp","rtsp","ssh","vnc","websocket"],"nullable":false,"type":"string"},"template":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"port":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"device":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"serviceGroup":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"username":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"password":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"authDomain":{"maxLength":253,"minLength":4,"nullable":true,"pattern":".+(\\..[^.]+)","type":"string"},"landingPage":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"connectionQuality":{"enum":["low","normal","high"],"nullable":true,"type":"string"},"readOnly":{"nullable":true,"type":"boolean"},"vncRightClickOnTouchHold":{"nullable":false,"type":"boolean"},"vncEncoding":{"enum":["copyrect","corre","hextile","raw","rre","tight","ultra","ultrazip","zlib","zlibhex","zrle","zywrle"],"nullable":true,"type":"string"},"useSsl":{"nullable":false,"type":"boolean"},"visibleInMobileApp":{"nullable":false,"type":"boolean"},"visibleOnWeb":{"nullable":false,"type":"boolean"},"httpAuthenticationType":{"enum":["ntlm","basic","digest"],"nullable":true,"type":"string"},"recordSessions":{"nullable":true,"type":"boolean"},"audience":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"requireAccessApproval":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"}},"required":["type","name","port","device","audience"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"patch":{"tags":["AgentServerList"],"summary":"AgentServerList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"device":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"serviceGroup":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"port":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"username":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"password":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"authDomain":{"maxLength":253,"minLength":4,"nullable":true,"pattern":".+(\\..[^.]+)","type":"string"},"landingPage":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"connectionQuality":{"enum":["low","normal","high"],"nullable":true,"type":"string"},"readOnly":{"nullable":true,"type":"boolean"},"vncRightClickOnTouchHold":{"nullable":false,"type":"boolean"},"vncEncoding":{"enum":["copyrect","corre","hextile","raw","rre","tight","ultra","ultrazip","zlib","zlibhex","zrle","zywrle"],"nullable":true,"type":"string"},"useSsl":{"nullable":false,"type":"boolean"},"visibleInMobileApp":{"nullable":false,"type":"boolean"},"visibleOnWeb":{"nullable":false,"type":"boolean"},"httpAuthenticationType":{"enum":["ntlm","basic","digest"],"nullable":true,"type":"string"},"recordSessions":{"nullable":true,"type":"boolean"},"audience":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"requireAccessApproval":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"delete":{"tags":["AgentServerList"],"summary":"AgentServerList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/agent-templates/{publicId}":{"get":{"tags":["AgentTemplate"],"summary":"AgentTemplate","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"company":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"group":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"name":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"description":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"useStunnel":{"nullable":false,"type":"boolean"},"config":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"configFileServer":{"maxLength":4294967295,"minLength":0,"nullable":true,"type":"string"},"configPushedOn":{"nullable":true,"type":"string","format":"date-time"},"configFileReported":{"maxLength":4294967295,"minLength":0,"nullable":true,"type":"string"},"configFileReportedWlanKeyEnabled":{"nullable":false,"type":"boolean"},"configFileReportedCellularPasswordEnabled":{"nullable":false,"type":"boolean"},"configReportedOn":{"nullable":true,"type":"string","format":"date-time"},"differentConfigs":{"nullable":false,"type":"boolean"},"differentWanConfigs":{"nullable":false,"type":"boolean"},"stewardConfigFileServer":{"maxLength":4294967295,"minLength":0,"nullable":true,"type":"string"},"stewardConfigFileReported":{"maxLength":4294967295,"minLength":0,"nullable":true,"type":"string"},"stewardConfigReportedOn":{"nullable":true,"type":"string","format":"date-time"},"differentStewardConfigs":{"nullable":false,"type":"boolean"},"routerLan":{"nullable":false,"type":"object","properties":{"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"ipAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"netMask":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"network":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"dhcpServerEnabled":{"nullable":false,"type":"boolean"},"dhcpServerRangeFrom":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"dhcpServerRangeTo":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"gatewayLessRouting":{"nullable":false,"type":"boolean"},"forwardLanWan":{"enum":["neither","public","private","both"],"nullable":false,"type":"string"},"forwardLanWan2":{"enum":["neither","public","private","both"],"nullable":false,"type":"string"},"wlanEnable":{"nullable":true,"type":"boolean"},"wlanSsid":{"maxLength":32,"minLength":0,"nullable":true,"type":"string"},"wlanKey":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"wlanChannel":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"bacnetBbmd":{"type":"array","items":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}},"udpBroadcastRelayPort":{"type":"array","items":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}}}},"routerVpn":{"nullable":false,"type":"object","properties":{"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"sourceNatEnabled":{"nullable":false,"type":"boolean"}}},"routerWan":{"nullable":false,"type":"object","properties":{"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"multiwanPolicy":{"enum":["eth_cell_wifi","cell_eth_wifi","eth_wifi_cell","wifi_eth_cell","cell_wifi_eth","wifi_cell_eth"],"nullable":true,"type":"string"},"ipUseDhcp":{"nullable":true,"type":"boolean"},"ipAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"ipGateway":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"ipNetMask":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"dnsServers":{"type":"array","items":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}},"dnsRebindProtectionEnabled":{"nullable":true,"type":"boolean"},"cellularApn":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"cellularPincode":{"maxLength":8,"minLength":0,"nullable":true,"type":"string"},"cellularMtu":{"maximum":1500,"minimum":576,"nullable":true,"type":"integer","format":"int32"},"digitalInputMode":{"enum":["disable_vpn_high","disable_vpn_low","disable_wan_high","disable_wan_low"],"nullable":true,"type":"string"},"wanTrackInterval":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"wanTrackIps":{"type":"array","items":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}},"wlanTrackInterval":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"wlanTrackIps":{"type":"array","items":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}},"cellularTrackInterval":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"cellularTrackIps":{"type":"array","items":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}},"httpProxyAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"httpProxyPort":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"httpProxyAuthentication":{"enum":["none","basic","ntlm"],"nullable":true,"type":"string"},"httpProxyUsername":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"httpProxyIsSocks5":{"nullable":true,"type":"boolean"},"wlanSsid":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"wlanIpUseDhcp":{"nullable":true,"type":"boolean"},"wlanIpAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"wlanIpGateway":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"wlanIpNetMask":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"wlanDnsServers":{"type":"array","items":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}},"cellularUsername":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"}}},"routerDisplay":{"nullable":false,"type":"object","properties":{"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"lockEnabled":{"nullable":false,"type":"boolean"},"lockCode":{"maxLength":4,"minLength":4,"nullable":true,"pattern":"[0-9]+","type":"string"}}},"routerAdditionalSubnets":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"networkAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"networkMask":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"gatewayAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}},"routerPortForwards":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"interface":{"enum":["VPN","WAN","WAN2"],"nullable":false,"type":"string"},"targetIpAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"targetPort":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"externalPort":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}},"routerNtpServers":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"server":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}}},"card":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"vpnAudience":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"custom":{"nullable":false,"type":"object"},"default":{"nullable":false,"type":"boolean"},"type":{"enum":["alarm","page","service"],"nullable":true,"type":"string"}}},"vpnRequireAccessApproval":{"nullable":false,"type":"boolean"},"vpnAccessRules":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"audience":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"ipAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"netMask":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}}}},"vpnVisibleInMobileApp":{"nullable":false,"type":"boolean"},"vpnVisibleOnWeb":{"nullable":false,"type":"boolean"},"dataAudience":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"custom":{"nullable":false,"type":"object"},"default":{"nullable":false,"type":"boolean"},"type":{"enum":["alarm","page","service"],"nullable":true,"type":"string"}}},"lanWanAccessRules":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"sourceIpAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"sourceMacAddress":{"maxLength":17,"minLength":17,"nullable":true,"pattern":"[0-9a-fA-F]{2}(:[0-9a-fA-F]{2}){5}","type":"string"},"destinationPort":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"destinationIpAddress":{"maxLength":19,"minLength":7,"nullable":true,"pattern":"\\d{1,3}(\\.\\d{1,3}){3}(\\/\\d{1,3})?","type":"string"},"protocol":{"enum":["all","tcp","udp","icmp","ah","ax.25","dccp","ddp","egp","eigrp","encap","esp","etherip","fc","ggp","gre","hmp","idpr-cmtp","idrp","igmp","igp","ipcomp","ipencap","ipip","ipv6","ipv6-frag","ipv6-icmp","ipv6-nonxt","ipv6-opts","ipv6-route","isis","iso-tp4","l2tp","ospf","pim","pup","rdp","rspf","rsvp","sctp","skip","st","vmtp","vrrp","xns-idp","xtp"],"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"}}}},"oneToOneNatRules":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"type":{"enum":["wan","wlan","vpn"],"nullable":false,"type":"string"},"virtualIpAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"destinationIpAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"protocol":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"port":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"sourceIpAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"}}}},"devices":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"ipAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"macAddress":{"maxLength":17,"minLength":17,"nullable":true,"pattern":"[0-9a-fA-F]{2}(:[0-9a-fA-F]{2}){5}","type":"string"},"customAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"dataSources":{"type":"array","items":{"nullable":false,"type":"object","properties":{"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"continueLoggingOnError":{"nullable":true,"type":"boolean"},"device":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"gracePeriod":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"slug":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"^[a-zA-Z0-9_\\[\\]-]+$","type":"string"},"disabled":{"nullable":false,"type":"boolean"},"protocol":{"oneOf":[{"type":"object","properties":{"publicId":{"enum":["custom"],"nullable":false,"type":"string"},"password":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}},"required":["publicId","password"]},{"type":"object","properties":{"publicId":{"enum":["modbus"],"nullable":false,"type":"string"},"slave":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"format":{"enum":["ABCD","BADC","CDAB","DCBA"],"nullable":true,"type":"string"},"readMode":{"enum":["single_value","consecutive_values","gapped_values"],"nullable":true,"type":"string"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["siemens-step7"],"nullable":false,"type":"string"},"pdu":{"maximum":2147483647,"minimum":-2147483648,"nullable":true,"type":"integer","format":"int32"},"rack":{"maximum":7,"nullable":true,"type":"integer","format":"int32"},"slot":{"maximum":31,"nullable":true,"type":"integer","format":"int32"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["opc-ua"],"nullable":false,"type":"string"},"authenticationType":{"enum":["anonymous","username","certificate"],"nullable":false,"type":"string"},"username":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"password":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"securityMode":{"enum":["sign","signandencrypt"],"nullable":true,"type":"string"},"securityPolicy":{"enum":["basic256sha256","aes128_sha256_rsaoaep","aes256_sha256_rsapss"],"nullable":true,"type":"string"}},"required":["publicId","authenticationType"]},{"type":"object","properties":{"publicId":{"enum":["ethernet-ip"],"nullable":false,"type":"string"},"cpu":{"enum":["compactlogix","micro800","micrologix","micrologix800","omron"],"nullable":false,"type":"string"},"rack":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"slot":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"}},"required":["publicId","cpu"]},{"type":"object","properties":{"publicId":{"enum":["host"],"nullable":false,"type":"string"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["bacnet-ip"],"nullable":false,"type":"string"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["mc-protocol"],"nullable":false,"type":"string"},"cpu":{"enum":["FX5U","IQR","L","Q","QNUCPU"],"nullable":true,"type":"string"},"protocol":{"enum":["TCP","UDP"],"nullable":true,"type":"string"},"networkNo":{"maximum":255,"nullable":true,"type":"integer","format":"int32"},"pcNo":{"maxLength":2,"minLength":1,"nullable":true,"pattern":"[A-Za-z0-9]+","type":"string"},"requestDestIoNr":{"maxLength":4,"minLength":1,"nullable":true,"pattern":"[A-Za-z0-9]+","type":"string"},"requestDestModuleStatNr":{"maximum":255,"nullable":true,"type":"integer","format":"int32"},"authenticationType":{"enum":["none","password"],"nullable":true,"type":"string"},"password":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"reconnectDelay":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"maxBlocks":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"maxPoints":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"}},"required":["publicId"]}]},"port":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"pullDelay":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"valuesPerHour":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"mqttTopic":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"mqttBrokerClient":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}}}}},"servers":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"type":{"enum":["http","rdp","rtsp","ssh","vnc","websocket"],"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"port":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"username":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"password":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"hasPassword":{"nullable":false,"type":"boolean"},"authDomain":{"maxLength":253,"minLength":4,"nullable":true,"pattern":".+(\\..[^.]+)","type":"string"},"landingPage":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"connectionQuality":{"enum":["low","normal","high"],"nullable":true,"type":"string"},"readOnly":{"nullable":true,"type":"boolean"},"vncRightClickOnTouchHold":{"nullable":false,"type":"boolean"},"vncEncoding":{"enum":["copyrect","corre","hextile","raw","rre","tight","ultra","ultrazip","zlib","zlibhex","zrle","zywrle"],"nullable":true,"type":"string"},"useSsl":{"nullable":false,"type":"boolean"},"visibleInMobileApp":{"nullable":false,"type":"boolean"},"visibleOnWeb":{"nullable":false,"type":"boolean"},"httpAuthenticationType":{"enum":["ntlm","basic","digest"],"nullable":true,"type":"string"},"recordSessions":{"nullable":true,"type":"boolean"},"audience":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"requireAccessApproval":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"device":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"serviceGroup":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"template":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"type":{"enum":["http","rdp","rtsp","ssh","vnc","websocket"],"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"port":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"username":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"password":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"hasPassword":{"nullable":false,"type":"boolean"},"authDomain":{"maxLength":253,"minLength":4,"nullable":true,"pattern":".+(\\..[^.]+)","type":"string"},"landingPage":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"connectionQuality":{"enum":["low","normal","high"],"nullable":true,"type":"string"},"readOnly":{"nullable":true,"type":"boolean"},"vncRightClickOnTouchHold":{"nullable":false,"type":"boolean"},"vncEncoding":{"enum":["copyrect","corre","hextile","raw","rre","tight","ultra","ultrazip","zlib","zlibhex","zrle","zywrle"],"nullable":true,"type":"string"},"useSsl":{"nullable":false,"type":"boolean"},"visibleInMobileApp":{"nullable":false,"type":"boolean"},"visibleOnWeb":{"nullable":false,"type":"boolean"},"httpAuthenticationType":{"enum":["ntlm","basic","digest"],"nullable":true,"type":"string"},"recordSessions":{"nullable":true,"type":"boolean"},"audience":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"requireAccessApproval":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"}}}}}},"pageLinks":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"asset":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"menuItem":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"page":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"audience":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"custom":{"nullable":false,"type":"object"},"default":{"nullable":false,"type":"boolean"},"type":{"enum":["alarm","page","service"],"nullable":true,"type":"string"}}},"group":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"asset":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"menuItem":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"custom":{"nullable":false,"type":"object"}}}},"type":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"additionalSubnets":{"nullable":false,"type":"boolean"},"allowDataPublishing":{"nullable":false,"type":"boolean"},"allowDemoDevice":{"nullable":false,"type":"boolean"},"allowTemplating":{"nullable":false,"type":"boolean"},"allowReboot":{"nullable":false,"type":"boolean"},"configPush":{"nullable":false,"type":"boolean"},"configFileFormat":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"customServers":{"nullable":false,"type":"boolean"},"deviceIdFormat":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"httpProxyPort":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"latestFirmwareFile":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"code":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"notes":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"agentType":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"type":{"enum":["firmware"],"nullable":false,"type":"string"},"latest":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"offlineConfiguration":{"nullable":false,"type":"boolean"},"openvpnConfigMultiUse":{"nullable":false,"type":"boolean"},"purchasePrice":{"nullable":false,"type":"object","properties":{"gratis":{"nullable":false,"type":"boolean"}}},"router":{"nullable":false,"type":"boolean"},"stunnelSupport":{"nullable":false,"type":"boolean"},"wanPortForwardings":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"},"hasSecondWanPort":{"nullable":false,"type":"boolean"}}},"dataSources":{"type":"array","items":{"nullable":false,"type":"object","properties":{"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"continueLoggingOnError":{"nullable":true,"type":"boolean"},"device":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"gracePeriod":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"slug":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"^[a-zA-Z0-9_\\[\\]-]+$","type":"string"},"disabled":{"nullable":false,"type":"boolean"},"protocol":{"oneOf":[{"type":"object","properties":{"publicId":{"enum":["custom"],"nullable":false,"type":"string"},"password":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}},"required":["publicId","password"]},{"type":"object","properties":{"publicId":{"enum":["modbus"],"nullable":false,"type":"string"},"slave":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"format":{"enum":["ABCD","BADC","CDAB","DCBA"],"nullable":true,"type":"string"},"readMode":{"enum":["single_value","consecutive_values","gapped_values"],"nullable":true,"type":"string"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["siemens-step7"],"nullable":false,"type":"string"},"pdu":{"maximum":2147483647,"minimum":-2147483648,"nullable":true,"type":"integer","format":"int32"},"rack":{"maximum":7,"nullable":true,"type":"integer","format":"int32"},"slot":{"maximum":31,"nullable":true,"type":"integer","format":"int32"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["opc-ua"],"nullable":false,"type":"string"},"authenticationType":{"enum":["anonymous","username","certificate"],"nullable":false,"type":"string"},"username":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"password":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"securityMode":{"enum":["sign","signandencrypt"],"nullable":true,"type":"string"},"securityPolicy":{"enum":["basic256sha256","aes128_sha256_rsaoaep","aes256_sha256_rsapss"],"nullable":true,"type":"string"}},"required":["publicId","authenticationType"]},{"type":"object","properties":{"publicId":{"enum":["ethernet-ip"],"nullable":false,"type":"string"},"cpu":{"enum":["compactlogix","micro800","micrologix","micrologix800","omron"],"nullable":false,"type":"string"},"rack":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"slot":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"}},"required":["publicId","cpu"]},{"type":"object","properties":{"publicId":{"enum":["host"],"nullable":false,"type":"string"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["bacnet-ip"],"nullable":false,"type":"string"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["mc-protocol"],"nullable":false,"type":"string"},"cpu":{"enum":["FX5U","IQR","L","Q","QNUCPU"],"nullable":true,"type":"string"},"protocol":{"enum":["TCP","UDP"],"nullable":true,"type":"string"},"networkNo":{"maximum":255,"nullable":true,"type":"integer","format":"int32"},"pcNo":{"maxLength":2,"minLength":1,"nullable":true,"pattern":"[A-Za-z0-9]+","type":"string"},"requestDestIoNr":{"maxLength":4,"minLength":1,"nullable":true,"pattern":"[A-Za-z0-9]+","type":"string"},"requestDestModuleStatNr":{"maximum":255,"nullable":true,"type":"integer","format":"int32"},"authenticationType":{"enum":["none","password"],"nullable":true,"type":"string"},"password":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"reconnectDelay":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"maxBlocks":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"maxPoints":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"}},"required":["publicId"]}]},"port":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"pullDelay":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"valuesPerHour":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"mqttTopic":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"mqttBrokerClient":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}},"vpnProtocol":{"enum":["udp","tcp"],"nullable":false,"type":"string"},"updatedOn":{"nullable":true,"type":"string","format":"date-time"},"updatedBy":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"latestVersion":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"createdOn":{"nullable":false,"type":"string","format":"date-time"},"number":{"maxLength":64,"minLength":1,"nullable":false,"type":"string"}}},"custom":{"nullable":false,"type":"object"}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"patch":{"tags":["AgentTemplate"],"summary":"AgentTemplate","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"group":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"useStunnel":{"nullable":false,"type":"boolean"},"card":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"vpnAudience":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"vpnRequireAccessApproval":{"nullable":false,"type":"boolean"},"vpnVisibleInMobileApp":{"nullable":false,"type":"boolean"},"vpnVisibleOnWeb":{"nullable":false,"type":"boolean"},"dataAudience":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"vpnProtocol":{"enum":["udp","tcp"],"nullable":false,"type":"string"},"custom":{"nullable":false,"type":"object"}}}}}},"security":[{"bearerToken":[]}]},"delete":{"tags":["AgentTemplate"],"summary":"AgentTemplate","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/agent-templates/from-agent":{"post":{"tags":["AgentTemplateFromAgentList"],"summary":"AgentTemplateFromAgentList","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"group":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}},"required":["agent","name"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/agent-templates":{"get":{"tags":["AgentTemplateList"],"summary":"AgentTemplateList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"company":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"group":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"name":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"description":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"useStunnel":{"nullable":false,"type":"boolean"},"config":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"configFileServer":{"maxLength":4294967295,"minLength":0,"nullable":true,"type":"string"},"configPushedOn":{"nullable":true,"type":"string","format":"date-time"},"configFileReported":{"maxLength":4294967295,"minLength":0,"nullable":true,"type":"string"},"configFileReportedWlanKeyEnabled":{"nullable":false,"type":"boolean"},"configFileReportedCellularPasswordEnabled":{"nullable":false,"type":"boolean"},"configReportedOn":{"nullable":true,"type":"string","format":"date-time"},"differentConfigs":{"nullable":false,"type":"boolean"},"differentWanConfigs":{"nullable":false,"type":"boolean"},"stewardConfigFileServer":{"maxLength":4294967295,"minLength":0,"nullable":true,"type":"string"},"stewardConfigFileReported":{"maxLength":4294967295,"minLength":0,"nullable":true,"type":"string"},"stewardConfigReportedOn":{"nullable":true,"type":"string","format":"date-time"},"differentStewardConfigs":{"nullable":false,"type":"boolean"},"routerLan":{"nullable":false,"type":"object","properties":{"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"ipAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"netMask":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"network":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"dhcpServerEnabled":{"nullable":false,"type":"boolean"},"dhcpServerRangeFrom":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"dhcpServerRangeTo":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"gatewayLessRouting":{"nullable":false,"type":"boolean"},"forwardLanWan":{"enum":["neither","public","private","both"],"nullable":false,"type":"string"},"forwardLanWan2":{"enum":["neither","public","private","both"],"nullable":false,"type":"string"},"wlanEnable":{"nullable":true,"type":"boolean"},"wlanSsid":{"maxLength":32,"minLength":0,"nullable":true,"type":"string"},"wlanKey":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"wlanChannel":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"bacnetBbmd":{"type":"array","items":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}},"udpBroadcastRelayPort":{"type":"array","items":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}}}},"routerVpn":{"nullable":false,"type":"object","properties":{"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"sourceNatEnabled":{"nullable":false,"type":"boolean"}}},"routerWan":{"nullable":false,"type":"object","properties":{"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"multiwanPolicy":{"enum":["eth_cell_wifi","cell_eth_wifi","eth_wifi_cell","wifi_eth_cell","cell_wifi_eth","wifi_cell_eth"],"nullable":true,"type":"string"},"ipUseDhcp":{"nullable":true,"type":"boolean"},"ipAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"ipGateway":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"ipNetMask":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"dnsServers":{"type":"array","items":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}},"dnsRebindProtectionEnabled":{"nullable":true,"type":"boolean"},"cellularApn":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"cellularPincode":{"maxLength":8,"minLength":0,"nullable":true,"type":"string"},"cellularMtu":{"maximum":1500,"minimum":576,"nullable":true,"type":"integer","format":"int32"},"digitalInputMode":{"enum":["disable_vpn_high","disable_vpn_low","disable_wan_high","disable_wan_low"],"nullable":true,"type":"string"},"wanTrackInterval":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"wanTrackIps":{"type":"array","items":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}},"wlanTrackInterval":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"wlanTrackIps":{"type":"array","items":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}},"cellularTrackInterval":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"cellularTrackIps":{"type":"array","items":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}},"httpProxyAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"httpProxyPort":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"httpProxyAuthentication":{"enum":["none","basic","ntlm"],"nullable":true,"type":"string"},"httpProxyUsername":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"httpProxyIsSocks5":{"nullable":true,"type":"boolean"},"wlanSsid":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"wlanIpUseDhcp":{"nullable":true,"type":"boolean"},"wlanIpAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"wlanIpGateway":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"wlanIpNetMask":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"wlanDnsServers":{"type":"array","items":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}},"cellularUsername":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"}}},"routerDisplay":{"nullable":false,"type":"object","properties":{"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"lockEnabled":{"nullable":false,"type":"boolean"},"lockCode":{"maxLength":4,"minLength":4,"nullable":true,"pattern":"[0-9]+","type":"string"}}},"routerAdditionalSubnets":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"networkAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"networkMask":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"gatewayAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}},"routerPortForwards":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"interface":{"enum":["VPN","WAN","WAN2"],"nullable":false,"type":"string"},"targetIpAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"targetPort":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"externalPort":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}},"routerNtpServers":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"server":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}}},"card":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"vpnAudience":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"custom":{"nullable":false,"type":"object"},"default":{"nullable":false,"type":"boolean"},"type":{"enum":["alarm","page","service"],"nullable":true,"type":"string"}}},"vpnRequireAccessApproval":{"nullable":false,"type":"boolean"},"vpnAccessRules":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"audience":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"ipAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"netMask":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}}}},"vpnVisibleInMobileApp":{"nullable":false,"type":"boolean"},"vpnVisibleOnWeb":{"nullable":false,"type":"boolean"},"dataAudience":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"custom":{"nullable":false,"type":"object"},"default":{"nullable":false,"type":"boolean"},"type":{"enum":["alarm","page","service"],"nullable":true,"type":"string"}}},"lanWanAccessRules":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"sourceIpAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"sourceMacAddress":{"maxLength":17,"minLength":17,"nullable":true,"pattern":"[0-9a-fA-F]{2}(:[0-9a-fA-F]{2}){5}","type":"string"},"destinationPort":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"destinationIpAddress":{"maxLength":19,"minLength":7,"nullable":true,"pattern":"\\d{1,3}(\\.\\d{1,3}){3}(\\/\\d{1,3})?","type":"string"},"protocol":{"enum":["all","tcp","udp","icmp","ah","ax.25","dccp","ddp","egp","eigrp","encap","esp","etherip","fc","ggp","gre","hmp","idpr-cmtp","idrp","igmp","igp","ipcomp","ipencap","ipip","ipv6","ipv6-frag","ipv6-icmp","ipv6-nonxt","ipv6-opts","ipv6-route","isis","iso-tp4","l2tp","ospf","pim","pup","rdp","rspf","rsvp","sctp","skip","st","vmtp","vrrp","xns-idp","xtp"],"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"}}}},"oneToOneNatRules":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"type":{"enum":["wan","wlan","vpn"],"nullable":false,"type":"string"},"virtualIpAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"destinationIpAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"protocol":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"port":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"sourceIpAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"}}}},"devices":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"ipAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"macAddress":{"maxLength":17,"minLength":17,"nullable":true,"pattern":"[0-9a-fA-F]{2}(:[0-9a-fA-F]{2}){5}","type":"string"},"customAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"dataSources":{"type":"array","items":{"nullable":false,"type":"object","properties":{"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"continueLoggingOnError":{"nullable":true,"type":"boolean"},"device":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"gracePeriod":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"slug":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"^[a-zA-Z0-9_\\[\\]-]+$","type":"string"},"disabled":{"nullable":false,"type":"boolean"},"protocol":{"oneOf":[{"type":"object","properties":{"publicId":{"enum":["custom"],"nullable":false,"type":"string"},"password":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}},"required":["publicId","password"]},{"type":"object","properties":{"publicId":{"enum":["modbus"],"nullable":false,"type":"string"},"slave":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"format":{"enum":["ABCD","BADC","CDAB","DCBA"],"nullable":true,"type":"string"},"readMode":{"enum":["single_value","consecutive_values","gapped_values"],"nullable":true,"type":"string"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["siemens-step7"],"nullable":false,"type":"string"},"pdu":{"maximum":2147483647,"minimum":-2147483648,"nullable":true,"type":"integer","format":"int32"},"rack":{"maximum":7,"nullable":true,"type":"integer","format":"int32"},"slot":{"maximum":31,"nullable":true,"type":"integer","format":"int32"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["opc-ua"],"nullable":false,"type":"string"},"authenticationType":{"enum":["anonymous","username","certificate"],"nullable":false,"type":"string"},"username":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"password":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"securityMode":{"enum":["sign","signandencrypt"],"nullable":true,"type":"string"},"securityPolicy":{"enum":["basic256sha256","aes128_sha256_rsaoaep","aes256_sha256_rsapss"],"nullable":true,"type":"string"}},"required":["publicId","authenticationType"]},{"type":"object","properties":{"publicId":{"enum":["ethernet-ip"],"nullable":false,"type":"string"},"cpu":{"enum":["compactlogix","micro800","micrologix","micrologix800","omron"],"nullable":false,"type":"string"},"rack":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"slot":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"}},"required":["publicId","cpu"]},{"type":"object","properties":{"publicId":{"enum":["host"],"nullable":false,"type":"string"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["bacnet-ip"],"nullable":false,"type":"string"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["mc-protocol"],"nullable":false,"type":"string"},"cpu":{"enum":["FX5U","IQR","L","Q","QNUCPU"],"nullable":true,"type":"string"},"protocol":{"enum":["TCP","UDP"],"nullable":true,"type":"string"},"networkNo":{"maximum":255,"nullable":true,"type":"integer","format":"int32"},"pcNo":{"maxLength":2,"minLength":1,"nullable":true,"pattern":"[A-Za-z0-9]+","type":"string"},"requestDestIoNr":{"maxLength":4,"minLength":1,"nullable":true,"pattern":"[A-Za-z0-9]+","type":"string"},"requestDestModuleStatNr":{"maximum":255,"nullable":true,"type":"integer","format":"int32"},"authenticationType":{"enum":["none","password"],"nullable":true,"type":"string"},"password":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"reconnectDelay":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"maxBlocks":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"maxPoints":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"}},"required":["publicId"]}]},"port":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"pullDelay":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"valuesPerHour":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"mqttTopic":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"mqttBrokerClient":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}}}}},"servers":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"type":{"enum":["http","rdp","rtsp","ssh","vnc","websocket"],"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"port":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"username":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"password":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"hasPassword":{"nullable":false,"type":"boolean"},"authDomain":{"maxLength":253,"minLength":4,"nullable":true,"pattern":".+(\\..[^.]+)","type":"string"},"landingPage":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"connectionQuality":{"enum":["low","normal","high"],"nullable":true,"type":"string"},"readOnly":{"nullable":true,"type":"boolean"},"vncRightClickOnTouchHold":{"nullable":false,"type":"boolean"},"vncEncoding":{"enum":["copyrect","corre","hextile","raw","rre","tight","ultra","ultrazip","zlib","zlibhex","zrle","zywrle"],"nullable":true,"type":"string"},"useSsl":{"nullable":false,"type":"boolean"},"visibleInMobileApp":{"nullable":false,"type":"boolean"},"visibleOnWeb":{"nullable":false,"type":"boolean"},"httpAuthenticationType":{"enum":["ntlm","basic","digest"],"nullable":true,"type":"string"},"recordSessions":{"nullable":true,"type":"boolean"},"audience":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"requireAccessApproval":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"device":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"serviceGroup":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"template":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"type":{"enum":["http","rdp","rtsp","ssh","vnc","websocket"],"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"port":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"username":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"password":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"hasPassword":{"nullable":false,"type":"boolean"},"authDomain":{"maxLength":253,"minLength":4,"nullable":true,"pattern":".+(\\..[^.]+)","type":"string"},"landingPage":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"connectionQuality":{"enum":["low","normal","high"],"nullable":true,"type":"string"},"readOnly":{"nullable":true,"type":"boolean"},"vncRightClickOnTouchHold":{"nullable":false,"type":"boolean"},"vncEncoding":{"enum":["copyrect","corre","hextile","raw","rre","tight","ultra","ultrazip","zlib","zlibhex","zrle","zywrle"],"nullable":true,"type":"string"},"useSsl":{"nullable":false,"type":"boolean"},"visibleInMobileApp":{"nullable":false,"type":"boolean"},"visibleOnWeb":{"nullable":false,"type":"boolean"},"httpAuthenticationType":{"enum":["ntlm","basic","digest"],"nullable":true,"type":"string"},"recordSessions":{"nullable":true,"type":"boolean"},"audience":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"requireAccessApproval":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"}}}}}},"pageLinks":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"asset":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"menuItem":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"page":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"audience":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"custom":{"nullable":false,"type":"object"},"default":{"nullable":false,"type":"boolean"},"type":{"enum":["alarm","page","service"],"nullable":true,"type":"string"}}},"group":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"asset":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"menuItem":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"custom":{"nullable":false,"type":"object"}}}},"type":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"additionalSubnets":{"nullable":false,"type":"boolean"},"allowDataPublishing":{"nullable":false,"type":"boolean"},"allowDemoDevice":{"nullable":false,"type":"boolean"},"allowTemplating":{"nullable":false,"type":"boolean"},"allowReboot":{"nullable":false,"type":"boolean"},"configPush":{"nullable":false,"type":"boolean"},"configFileFormat":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"customServers":{"nullable":false,"type":"boolean"},"deviceIdFormat":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"httpProxyPort":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"latestFirmwareFile":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"code":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"notes":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"agentType":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"type":{"enum":["firmware"],"nullable":false,"type":"string"},"latest":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"offlineConfiguration":{"nullable":false,"type":"boolean"},"openvpnConfigMultiUse":{"nullable":false,"type":"boolean"},"purchasePrice":{"nullable":false,"type":"object","properties":{"gratis":{"nullable":false,"type":"boolean"}}},"router":{"nullable":false,"type":"boolean"},"stunnelSupport":{"nullable":false,"type":"boolean"},"wanPortForwardings":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"},"hasSecondWanPort":{"nullable":false,"type":"boolean"}}},"dataSources":{"type":"array","items":{"nullable":false,"type":"object","properties":{"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"continueLoggingOnError":{"nullable":true,"type":"boolean"},"device":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"gracePeriod":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"slug":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"^[a-zA-Z0-9_\\[\\]-]+$","type":"string"},"disabled":{"nullable":false,"type":"boolean"},"protocol":{"oneOf":[{"type":"object","properties":{"publicId":{"enum":["custom"],"nullable":false,"type":"string"},"password":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}},"required":["publicId","password"]},{"type":"object","properties":{"publicId":{"enum":["modbus"],"nullable":false,"type":"string"},"slave":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"format":{"enum":["ABCD","BADC","CDAB","DCBA"],"nullable":true,"type":"string"},"readMode":{"enum":["single_value","consecutive_values","gapped_values"],"nullable":true,"type":"string"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["siemens-step7"],"nullable":false,"type":"string"},"pdu":{"maximum":2147483647,"minimum":-2147483648,"nullable":true,"type":"integer","format":"int32"},"rack":{"maximum":7,"nullable":true,"type":"integer","format":"int32"},"slot":{"maximum":31,"nullable":true,"type":"integer","format":"int32"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["opc-ua"],"nullable":false,"type":"string"},"authenticationType":{"enum":["anonymous","username","certificate"],"nullable":false,"type":"string"},"username":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"password":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"securityMode":{"enum":["sign","signandencrypt"],"nullable":true,"type":"string"},"securityPolicy":{"enum":["basic256sha256","aes128_sha256_rsaoaep","aes256_sha256_rsapss"],"nullable":true,"type":"string"}},"required":["publicId","authenticationType"]},{"type":"object","properties":{"publicId":{"enum":["ethernet-ip"],"nullable":false,"type":"string"},"cpu":{"enum":["compactlogix","micro800","micrologix","micrologix800","omron"],"nullable":false,"type":"string"},"rack":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"slot":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"}},"required":["publicId","cpu"]},{"type":"object","properties":{"publicId":{"enum":["host"],"nullable":false,"type":"string"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["bacnet-ip"],"nullable":false,"type":"string"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["mc-protocol"],"nullable":false,"type":"string"},"cpu":{"enum":["FX5U","IQR","L","Q","QNUCPU"],"nullable":true,"type":"string"},"protocol":{"enum":["TCP","UDP"],"nullable":true,"type":"string"},"networkNo":{"maximum":255,"nullable":true,"type":"integer","format":"int32"},"pcNo":{"maxLength":2,"minLength":1,"nullable":true,"pattern":"[A-Za-z0-9]+","type":"string"},"requestDestIoNr":{"maxLength":4,"minLength":1,"nullable":true,"pattern":"[A-Za-z0-9]+","type":"string"},"requestDestModuleStatNr":{"maximum":255,"nullable":true,"type":"integer","format":"int32"},"authenticationType":{"enum":["none","password"],"nullable":true,"type":"string"},"password":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"reconnectDelay":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"maxBlocks":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"maxPoints":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"}},"required":["publicId"]}]},"port":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"pullDelay":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"valuesPerHour":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"mqttTopic":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"mqttBrokerClient":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}},"vpnProtocol":{"enum":["udp","tcp"],"nullable":false,"type":"string"},"updatedOn":{"nullable":true,"type":"string","format":"date-time"},"updatedBy":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"latestVersion":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"createdOn":{"nullable":false,"type":"string","format":"date-time"},"number":{"maxLength":64,"minLength":1,"nullable":false,"type":"string"}}},"custom":{"nullable":false,"type":"object"}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"}],"security":[{"bearerToken":[]}]},"post":{"tags":["AgentTemplateList"],"summary":"AgentTemplateList","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"type":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"group":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"useStunnel":{"nullable":false,"type":"boolean"},"card":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"vpnAudience":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"vpnRequireAccessApproval":{"nullable":false,"type":"boolean"},"vpnVisibleInMobileApp":{"nullable":false,"type":"boolean"},"vpnVisibleOnWeb":{"nullable":false,"type":"boolean"},"dataAudience":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"vpnProtocol":{"enum":["udp","tcp"],"nullable":false,"type":"string"},"custom":{"nullable":false,"type":"object"}},"required":["type","name"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"patch":{"tags":["AgentTemplateList"],"summary":"AgentTemplateList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"group":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"useStunnel":{"nullable":false,"type":"boolean"},"card":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"vpnAudience":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"vpnRequireAccessApproval":{"nullable":false,"type":"boolean"},"vpnVisibleInMobileApp":{"nullable":false,"type":"boolean"},"vpnVisibleOnWeb":{"nullable":false,"type":"boolean"},"dataAudience":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"vpnProtocol":{"enum":["udp","tcp"],"nullable":false,"type":"string"},"custom":{"nullable":false,"type":"object"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"delete":{"tags":["AgentTemplateList"],"summary":"AgentTemplateList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/agent-templates/{agentId}/versions/{publicId}":{"get":{"tags":["AgentTemplateVersion"],"summary":"AgentTemplateVersion","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"createdOn":{"nullable":false,"type":"string","format":"date-time"},"createdBy":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"company":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"description":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"agentTemplate":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"number":{"maxLength":64,"minLength":1,"nullable":false,"type":"string"}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/agent-templates/{publicId}/version":{"post":{"tags":["AgentTemplateVersionFromTemplate"],"summary":"AgentTemplateVersionFromTemplate","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"description":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"}},"required":["publicId"]}}}},"security":[{"bearerToken":[]}]}},"/agent-templates/{agentId}/versions":{"get":{"tags":["AgentTemplateVersionList"],"summary":"AgentTemplateVersionList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"createdOn":{"nullable":false,"type":"string","format":"date-time"},"createdBy":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"company":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"description":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"agentTemplate":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"number":{"maxLength":64,"minLength":1,"nullable":false,"type":"string"}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/agent-types/{publicId}/files":{"get":{"tags":["AgentTypeFileList"],"summary":"AgentTypeFileList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"code":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"notes":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"agentType":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"type":{"enum":["firmware"],"nullable":false,"type":"string"},"latest":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/agent-types":{"get":{"tags":["AgentTypeList"],"summary":"AgentTypeList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"additionalSubnets":{"nullable":false,"type":"boolean"},"allowDataPublishing":{"nullable":false,"type":"boolean"},"allowDemoDevice":{"nullable":false,"type":"boolean"},"allowTemplating":{"nullable":false,"type":"boolean"},"allowReboot":{"nullable":false,"type":"boolean"},"configPush":{"nullable":false,"type":"boolean"},"configFileFormat":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"customServers":{"nullable":false,"type":"boolean"},"deviceIdFormat":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"httpProxyPort":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"latestFirmwareFile":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"code":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"notes":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"agentType":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"type":{"enum":["firmware"],"nullable":false,"type":"string"},"latest":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"offlineConfiguration":{"nullable":false,"type":"boolean"},"openvpnConfigMultiUse":{"nullable":false,"type":"boolean"},"purchasePrice":{"nullable":false,"type":"object","properties":{"gratis":{"nullable":false,"type":"boolean"}}},"router":{"nullable":false,"type":"boolean"},"stunnelSupport":{"nullable":false,"type":"boolean"},"wanPortForwardings":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"},"hasSecondWanPort":{"nullable":false,"type":"boolean"}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"}],"security":[{"bearerToken":[]}]}},"/agents/{agentId}/vpn-usage":{"post":{"tags":["AgentVpnUsage"],"summary":"AgentVpnUsage","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"bytesSent":{"minimum":1,"nullable":false,"type":"integer","format":"int32"},"bytesReceived":{"minimum":1,"nullable":false,"type":"integer","format":"int32"},"year":{"minimum":2000,"nullable":false,"type":"integer","format":"int32"},"month":{"maximum":12,"minimum":1,"nullable":true,"type":"integer","format":"int32"},"day":{"maximum":31,"minimum":1,"nullable":true,"type":"integer","format":"int32"},"hour":{"maximum":23,"nullable":true,"type":"integer","format":"int32"}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"aggregator":{"enum":["hourly","daily","monthly","yearly"],"nullable":false,"type":"string"},"before":{"nullable":false,"type":"string","format":"date-time"},"after":{"nullable":false,"type":"string","format":"date-time"}}}}}},"security":[{"bearerToken":[]}]}},"/agents/{agentId}/vpn-usage-2":{"post":{"tags":["AgentVpnUsageList"],"summary":"AgentVpnUsageList","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"bytesSent":{"minimum":1,"nullable":false,"type":"integer","format":"int32"},"bytesReceived":{"minimum":1,"nullable":false,"type":"integer","format":"int32"},"year":{"minimum":2000,"nullable":false,"type":"integer","format":"int32"},"month":{"maximum":12,"minimum":1,"nullable":true,"type":"integer","format":"int32"},"day":{"maximum":31,"minimum":1,"nullable":true,"type":"integer","format":"int32"},"hour":{"maximum":23,"nullable":true,"type":"integer","format":"int32"}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"agentId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"aggregator":{"enum":["hourly","daily","monthly","yearly"],"nullable":false,"type":"string"},"before":{"nullable":false,"type":"string","format":"date-time"},"after":{"nullable":false,"type":"string","format":"date-time"}},"required":["aggregator","before","after"]}}}},"security":[{"bearerToken":[]}]}},"/app-configs":{"patch":{"tags":["AppConfigUpdate"],"summary":"AppConfigUpdate","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"nullable":false,"type":"boolean"}},"required":["enabled"]}}}},"security":[{"bearerToken":[]}]}},"/apps/install/{publicId}":{"get":{"tags":["AppInstall"],"summary":"AppInstall","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"post":{"tags":["AppInstall"],"summary":"AppInstall","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/apps/uninstall/{publicId}":{"delete":{"tags":["AppUninstall"],"summary":"AppUninstall","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/assets/{publicId}":{"get":{"tags":["Asset"],"summary":"Asset","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"company":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"order":{"maximum":9223372036854776000,"minimum":-9223372036854776000,"nullable":false,"type":"integer","format":"int32"},"resourceVariant":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"company":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"order":{"maximum":9223372036854776000,"minimum":-9223372036854776000,"nullable":false,"type":"integer","format":"int32"}}},"slug":{"maxLength":260,"minLength":1,"nullable":true,"type":"string"},"parent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"pageLinks":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"asset":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"menuItem":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"page":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"audience":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"custom":{"nullable":false,"type":"object"},"default":{"nullable":false,"type":"boolean"},"type":{"enum":["alarm","page","service"],"nullable":true,"type":"string"}}},"group":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"asset":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"menuItem":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"custom":{"nullable":false,"type":"object"}}}},"memberships":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"asset":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"group":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}},"card":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"enabled":{"nullable":false,"type":"boolean"},"aiAssistantEnabled":{"nullable":false,"type":"boolean"},"aiAssistantUserGreeting":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"custom":{"nullable":false,"type":"object"},"agent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"appConfigs":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"app":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"asset":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"values":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"stateValues":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"resources":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"config":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"name":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"resourcePublicId":{"maxLength":12,"minLength":12,"nullable":true,"type":"string"},"resourceType":{"enum":["AgentDataTag"],"nullable":false,"type":"string"},"values":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"stateValues":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"slug":{"maxLength":64,"minLength":1,"nullable":false,"type":"string"}}}}}}},"libraryAsset":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"libraryVersion":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"library":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"version":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"description":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"publishedBy":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"publishedOn":{"nullable":false,"type":"string","format":"date-time"},"renderedYaml":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"latest":{"nullable":false,"type":"boolean"}}},"isLibraryAsset":{"nullable":false,"type":"boolean"},"hasChanges":{"nullable":false,"type":"boolean"},"root":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}}},"libraryRoot":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}}},"location":{"nullable":true,"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"latitude":{"nullable":false,"type":"string"},"longitude":{"nullable":false,"type":"string"}}},"timeZone":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"post":{"tags":["Asset"],"summary":"Asset","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"order":{"maximum":9223372036854776000,"minimum":-9223372036854776000,"nullable":false,"type":"integer","format":"int32"},"resourceVariant":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"slug":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"parent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"custom":{"nullable":false,"type":"object"}},"required":["name","resourceVariant"]}}}},"security":[{"bearerToken":[]}]},"patch":{"tags":["Asset"],"summary":"Asset","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"order":{"maximum":9223372036854776000,"minimum":-9223372036854776000,"nullable":false,"type":"integer","format":"int32"},"parent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"slug":{"maxLength":260,"minLength":1,"nullable":false,"type":"string"},"card":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"enabled":{"nullable":false,"type":"boolean"},"aiAssistantEnabled":{"nullable":false,"type":"boolean"},"aiAssistantUserGreeting":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"custom":{"nullable":false,"type":"object"},"agent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"location":{"nullable":true,"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"latitude":{"nullable":false,"type":"string"},"longitude":{"nullable":false,"type":"string"}}},"timeZone":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"}}}}}},"security":[{"bearerToken":[]}]},"delete":{"tags":["Asset"],"summary":"Asset","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/assets/app-configs/{publicId}":{"get":{"tags":["AssetAppConfig"],"summary":"AssetAppConfig","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"app":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"asset":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"values":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"stateValues":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"resources":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"config":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"name":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"resourcePublicId":{"maxLength":12,"minLength":12,"nullable":true,"type":"string"},"resourceType":{"enum":["AgentDataTag"],"nullable":false,"type":"string"},"values":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"stateValues":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"slug":{"maxLength":64,"minLength":1,"nullable":false,"type":"string"}}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"patch":{"tags":["AssetAppConfig"],"summary":"AssetAppConfig","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"values":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"stateValues":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"}}}}}},"security":[{"bearerToken":[]}]},"delete":{"tags":["AssetAppConfig"],"summary":"AssetAppConfig","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/assets/app-configs":{"get":{"tags":["AssetAppConfigList"],"summary":"AssetAppConfigList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"app":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"asset":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"values":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"stateValues":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"resources":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"config":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"name":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"resourcePublicId":{"maxLength":12,"minLength":12,"nullable":true,"type":"string"},"resourceType":{"enum":["AgentDataTag"],"nullable":false,"type":"string"},"values":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"stateValues":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"slug":{"maxLength":64,"minLength":1,"nullable":false,"type":"string"}}}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"}],"security":[{"bearerToken":[]}]},"post":{"tags":["AssetAppConfigList"],"summary":"AssetAppConfigList","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"app":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"asset":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"values":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"stateValues":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"}},"required":["app","asset"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"patch":{"tags":["AssetAppConfigList"],"summary":"AssetAppConfigList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"values":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"stateValues":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"delete":{"tags":["AssetAppConfigList"],"summary":"AssetAppConfigList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/assets/app-configs/resources/{publicId}":{"get":{"tags":["AssetAppConfigResource"],"summary":"AssetAppConfigResource","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"config":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"name":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"resourcePublicId":{"maxLength":12,"minLength":12,"nullable":true,"type":"string"},"resourceType":{"enum":["AgentDataTag"],"nullable":false,"type":"string"},"values":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"stateValues":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"slug":{"maxLength":64,"minLength":1,"nullable":false,"type":"string"}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"patch":{"tags":["AssetAppConfigResource"],"summary":"AssetAppConfigResource","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"resourcePublicId":{"maxLength":12,"minLength":12,"nullable":true,"type":"string"},"values":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"stateValues":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"slug":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"^[a-zA-Z0-9_\\[\\]-]+$","type":"string"}}}}}},"security":[{"bearerToken":[]}]},"delete":{"tags":["AssetAppConfigResource"],"summary":"AssetAppConfigResource","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/assets/app-configs/resources":{"post":{"tags":["AssetAppConfigResourceList"],"summary":"AssetAppConfigResourceList","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"config":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"name":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"resourcePublicId":{"maxLength":12,"minLength":12,"nullable":true,"type":"string"},"resourceType":{"enum":["AgentDataTag"],"nullable":false,"type":"string"},"values":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"stateValues":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"slug":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"^[a-zA-Z0-9_\\[\\]-]+$","type":"string"}},"required":["config","resourceType","slug"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"patch":{"tags":["AssetAppConfigResourceList"],"summary":"AssetAppConfigResourceList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"resourcePublicId":{"maxLength":12,"minLength":12,"nullable":true,"type":"string"},"values":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"stateValues":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"slug":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"^[a-zA-Z0-9_\\[\\]-]+$","type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"delete":{"tags":["AssetAppConfigResourceList"],"summary":"AssetAppConfigResourceList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/assets/{assetId}/backend-component-function-call":{"post":{"tags":["AssetBackendComponentFunctionCall"],"summary":"AssetBackendComponentFunctionCall","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"value":{"nullable":false}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"assetId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"template":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"arguments":{"nullable":true}},"required":["template","name"]}}}},"security":[{"bearerToken":[]}]}},"/assets/{publicId}/descendants":{"get":{"tags":["AssetDescendantList"],"summary":"AssetDescendantList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"company":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"order":{"maximum":9223372036854776000,"minimum":-9223372036854776000,"nullable":false,"type":"integer","format":"int32"},"resourceVariant":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"company":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"order":{"maximum":9223372036854776000,"minimum":-9223372036854776000,"nullable":false,"type":"integer","format":"int32"}}},"slug":{"maxLength":260,"minLength":1,"nullable":true,"type":"string"},"parent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"pageLinks":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"asset":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"menuItem":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"page":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"audience":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"custom":{"nullable":false,"type":"object"},"default":{"nullable":false,"type":"boolean"},"type":{"enum":["alarm","page","service"],"nullable":true,"type":"string"}}},"group":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"asset":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"menuItem":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"custom":{"nullable":false,"type":"object"}}}},"memberships":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"asset":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"group":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}},"card":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"enabled":{"nullable":false,"type":"boolean"},"aiAssistantEnabled":{"nullable":false,"type":"boolean"},"aiAssistantUserGreeting":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"custom":{"nullable":false,"type":"object"},"agent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"appConfigs":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"app":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"asset":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"values":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"stateValues":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"resources":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"config":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"name":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"resourcePublicId":{"maxLength":12,"minLength":12,"nullable":true,"type":"string"},"resourceType":{"enum":["AgentDataTag"],"nullable":false,"type":"string"},"values":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"stateValues":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"slug":{"maxLength":64,"minLength":1,"nullable":false,"type":"string"}}}}}}},"libraryAsset":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"libraryVersion":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"library":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"version":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"description":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"publishedBy":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"publishedOn":{"nullable":false,"type":"string","format":"date-time"},"renderedYaml":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"latest":{"nullable":false,"type":"boolean"}}},"isLibraryAsset":{"nullable":false,"type":"boolean"},"hasChanges":{"nullable":false,"type":"boolean"},"root":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}}},"libraryRoot":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}}},"location":{"nullable":true,"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"latitude":{"nullable":false,"type":"string"},"longitude":{"nullable":false,"type":"string"}}},"timeZone":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/assets/{publicId}/library":{"post":{"tags":["AssetLibrary"],"summary":"AssetLibrary","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"delete":{"tags":["AssetLibrary"],"summary":"AssetLibrary","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/assets/library/instances/{publicId}/detach":{"patch":{"tags":["AssetLibraryInstanceDetach"],"summary":"AssetLibraryInstanceDetach","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/assets/library/instances/detach":{"patch":{"tags":["AssetLibraryInstanceDetachList"],"summary":"AssetLibraryInstanceDetachList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/assets/library/instances":{"post":{"tags":["AssetLibraryInstanceList"],"summary":"AssetLibraryInstanceList","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"parent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"libraryAsset":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"order":{"maximum":9223372036854776000,"minimum":-9223372036854776000,"nullable":false,"type":"integer","format":"int32"}},"required":["parent","libraryAsset"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"patch":{"tags":["AssetLibraryInstanceList"],"summary":"AssetLibraryInstanceList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"instance":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"version":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}},"required":["instance"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/assets/library":{"delete":{"tags":["AssetLibraryList"],"summary":"AssetLibraryList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"post":{"tags":["AssetLibraryList"],"summary":"AssetLibraryList","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"order":{"maximum":9223372036854776000,"minimum":-9223372036854776000,"nullable":false,"type":"integer","format":"int32"},"resourceVariant":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"slug":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"parent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"custom":{"nullable":false,"type":"object"}},"required":["name","resourceVariant"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/assets/library/versions":{"post":{"tags":["AssetLibraryVersionCompanyList"],"summary":"AssetLibraryVersionCompanyList","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"library":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"description":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"updateInstances":{"nullable":false,"type":"boolean"}},"required":["library","updateInstances"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"get":{"tags":["AssetLibraryVersionCompanyList"],"summary":"AssetLibraryVersionCompanyList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"library":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"version":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"description":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"publishedBy":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"publishedOn":{"nullable":false,"type":"string","format":"date-time"},"renderedYaml":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"latest":{"nullable":false,"type":"boolean"}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"}],"security":[{"bearerToken":[]}]}},"/assets/{assetId}/library/versions":{"get":{"tags":["AssetLibraryVersionList"],"summary":"AssetLibraryVersionList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"library":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"version":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"description":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"publishedBy":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"publishedOn":{"nullable":false,"type":"string","format":"date-time"},"renderedYaml":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"latest":{"nullable":false,"type":"boolean"}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"assetId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/assets":{"get":{"tags":["AssetList"],"summary":"AssetList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"company":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"order":{"maximum":9223372036854776000,"minimum":-9223372036854776000,"nullable":false,"type":"integer","format":"int32"},"resourceVariant":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"company":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"order":{"maximum":9223372036854776000,"minimum":-9223372036854776000,"nullable":false,"type":"integer","format":"int32"}}},"slug":{"maxLength":260,"minLength":1,"nullable":true,"type":"string"},"parent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"pageLinks":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"asset":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"menuItem":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"page":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"audience":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"custom":{"nullable":false,"type":"object"},"default":{"nullable":false,"type":"boolean"},"type":{"enum":["alarm","page","service"],"nullable":true,"type":"string"}}},"group":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"asset":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"menuItem":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"custom":{"nullable":false,"type":"object"}}}},"memberships":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"asset":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"group":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}},"card":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"enabled":{"nullable":false,"type":"boolean"},"aiAssistantEnabled":{"nullable":false,"type":"boolean"},"aiAssistantUserGreeting":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"custom":{"nullable":false,"type":"object"},"agent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"appConfigs":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"app":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"asset":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"values":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"stateValues":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"resources":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"config":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"name":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"resourcePublicId":{"maxLength":12,"minLength":12,"nullable":true,"type":"string"},"resourceType":{"enum":["AgentDataTag"],"nullable":false,"type":"string"},"values":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"stateValues":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"slug":{"maxLength":64,"minLength":1,"nullable":false,"type":"string"}}}}}}},"libraryAsset":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"libraryVersion":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"library":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"version":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"description":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"publishedBy":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"publishedOn":{"nullable":false,"type":"string","format":"date-time"},"renderedYaml":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"latest":{"nullable":false,"type":"boolean"}}},"isLibraryAsset":{"nullable":false,"type":"boolean"},"hasChanges":{"nullable":false,"type":"boolean"},"root":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}}},"libraryRoot":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}}},"location":{"nullable":true,"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"latitude":{"nullable":false,"type":"string"},"longitude":{"nullable":false,"type":"string"}}},"timeZone":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"}],"security":[{"bearerToken":[]}]},"post":{"tags":["AssetList"],"summary":"AssetList","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"order":{"maximum":9223372036854776000,"minimum":-9223372036854776000,"nullable":false,"type":"integer","format":"int32"},"resourceVariant":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"slug":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"parent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"custom":{"nullable":false,"type":"object"}},"required":["name","resourceVariant"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"patch":{"tags":["AssetList"],"summary":"AssetList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"order":{"maximum":9223372036854776000,"minimum":-9223372036854776000,"nullable":false,"type":"integer","format":"int32"},"parent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"slug":{"maxLength":260,"minLength":1,"nullable":false,"type":"string"},"card":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"enabled":{"nullable":false,"type":"boolean"},"aiAssistantEnabled":{"nullable":false,"type":"boolean"},"aiAssistantUserGreeting":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"custom":{"nullable":false,"type":"object"},"agent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"location":{"nullable":true,"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"latitude":{"nullable":false,"type":"string"},"longitude":{"nullable":false,"type":"string"}}},"timeZone":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"delete":{"tags":["AssetList"],"summary":"AssetList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/assets/memberships/{publicId}":{"get":{"tags":["AssetMembership"],"summary":"AssetMembership","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"asset":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"group":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"patch":{"tags":["AssetMembership"],"summary":"AssetMembership","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"asset":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"group":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}},"required":["asset","group"]}}}},"security":[{"bearerToken":[]}]},"delete":{"tags":["AssetMembership"],"summary":"AssetMembership","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/assets/memberships":{"get":{"tags":["AssetMembershipList"],"summary":"AssetMembershipList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"asset":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"group":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"}],"security":[{"bearerToken":[]}]},"post":{"tags":["AssetMembershipList"],"summary":"AssetMembershipList","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"asset":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"group":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}},"required":["asset","group"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"patch":{"tags":["AssetMembershipList"],"summary":"AssetMembershipList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"asset":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"group":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}},"required":["publicId","asset","group"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"delete":{"tags":["AssetMembershipList"],"summary":"AssetMembershipList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/assets/{assetId}/object-storage/delete":{"post":{"tags":["AssetObjectStorageDeleteAction"],"summary":"AssetObjectStorageDeleteAction","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"assetId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"template":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"uuid":{"maxLength":36,"minLength":36,"nullable":false,"type":"string","format":"uuid"},"arguments":{"nullable":true}},"required":["template","uuid"]}}}},"security":[{"bearerToken":[]}]}},"/assets/{assetId}/object-storage/download":{"post":{"tags":["AssetObjectStorageDownloadAction"],"summary":"AssetObjectStorageDownloadAction","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"url":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}},"required":["url"]}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"assetId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"template":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"uuid":{"maxLength":36,"minLength":36,"nullable":false,"type":"string","format":"uuid"},"arguments":{"nullable":true}},"required":["template","uuid"]}}}},"security":[{"bearerToken":[]}]}},"/assets/{assetId}/object-storage/list":{"post":{"tags":["AssetObjectStorageListAction"],"summary":"AssetObjectStorageListAction","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"uuid":{"maxLength":36,"minLength":36,"nullable":false,"type":"string","format":"uuid"},"size":{"maximum":2147483647,"minimum":-2147483648,"nullable":false,"type":"integer","format":"int32"},"tags":{"maxLength":65535,"nullable":false,"type":"object"},"agent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"asset":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}},"required":["uuid","size","tags"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"assetId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"template":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"arguments":{"nullable":true}},"required":["template"]}}}},"security":[{"bearerToken":[]}]}},"/assets/{assetId}/object-storage/meta":{"patch":{"tags":["AssetObjectStorageObjectMetaUpdateAction"],"summary":"AssetObjectStorageObjectMetaUpdateAction","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"assetId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"uuid":{"maxLength":36,"minLength":36,"nullable":false,"type":"string","format":"uuid"},"template":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"tags":{"maxLength":65535,"nullable":false,"type":"object"}},"required":["uuid","template"]}}}},"security":[{"bearerToken":[]}]}},"/assets/{assetId}/object-storage/upload":{"post":{"tags":["AssetObjectStorageUploadAction"],"summary":"AssetObjectStorageUploadAction","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"type":{"enum":["azure-blob-storage"],"nullable":false,"type":"string"},"url":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}},"required":["type","url"]}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"assetId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"template":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"uuid":{"maxLength":36,"minLength":36,"nullable":false,"type":"string","format":"uuid"},"arguments":{"nullable":true}},"required":["template","uuid"]}}}},"security":[{"bearerToken":[]}]}},"/assets/{assetId}/page-links/{publicId}":{"get":{"tags":["AssetPageLink"],"summary":"AssetPageLink","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"asset":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"menuItem":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"page":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"audience":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"custom":{"nullable":false,"type":"object"},"default":{"nullable":false,"type":"boolean"},"type":{"enum":["alarm","page","service"],"nullable":true,"type":"string"}}},"group":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"asset":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"menuItem":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"custom":{"nullable":false,"type":"object"}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"assetId","in":"path","schema":{"type":"string"}},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"patch":{"tags":["AssetPageLink"],"summary":"AssetPageLink","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"assetId","in":"path","schema":{"type":"string"}},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"page":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"audience":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"group":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"custom":{"nullable":false,"type":"object"}}}}}},"security":[{"bearerToken":[]}]},"delete":{"tags":["AssetPageLink"],"summary":"AssetPageLink","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"assetId","in":"path","schema":{"type":"string"}},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/assets/{assetId}/page-link-groups/{publicId}":{"get":{"tags":["AssetPageLinkGroup"],"summary":"AssetPageLinkGroup","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"asset":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"menuItem":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"assetId","in":"path","schema":{"type":"string"}},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"patch":{"tags":["AssetPageLinkGroup"],"summary":"AssetPageLinkGroup","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"assetId","in":"path","schema":{"type":"string"}},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}}},"security":[{"bearerToken":[]}]},"delete":{"tags":["AssetPageLinkGroup"],"summary":"AssetPageLinkGroup","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"assetId","in":"path","schema":{"type":"string"}},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/assets/{assetId}/page-link-groups":{"get":{"tags":["AssetPageLinkGroupList"],"summary":"AssetPageLinkGroupList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"asset":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"menuItem":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"assetId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"post":{"tags":["AssetPageLinkGroupList"],"summary":"AssetPageLinkGroupList","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"assetId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}},"required":["name"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"patch":{"tags":["AssetPageLinkGroupList"],"summary":"AssetPageLinkGroupList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"assetId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"delete":{"tags":["AssetPageLinkGroupList"],"summary":"AssetPageLinkGroupList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"assetId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/assets/{assetId}/page-links":{"get":{"tags":["AssetPageLinkList"],"summary":"AssetPageLinkList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"asset":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"menuItem":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"page":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"audience":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"custom":{"nullable":false,"type":"object"},"default":{"nullable":false,"type":"boolean"},"type":{"enum":["alarm","page","service"],"nullable":true,"type":"string"}}},"group":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"asset":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"menuItem":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"custom":{"nullable":false,"type":"object"}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"assetId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"post":{"tags":["AssetPageLinkList"],"summary":"AssetPageLinkList","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"assetId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"page":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"audience":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"group":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"custom":{"nullable":false,"type":"object"}},"required":["page","audience"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"patch":{"tags":["AssetPageLinkList"],"summary":"AssetPageLinkList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"assetId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"page":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"audience":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"group":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"custom":{"nullable":false,"type":"object"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"delete":{"tags":["AssetPageLinkList"],"summary":"AssetPageLinkList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"assetId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/assets/{assetId}/pages":{"get":{"tags":["AssetPageList"],"summary":"AssetPageList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"applicationType":{"enum":["sheet","card","report"],"nullable":false,"type":"string"},"company":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"group":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"draft":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"page":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"title":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"components":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"pageVersion":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"template":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"boundVersion":{"nullable":true,"type":"object","properties":{"template":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"number":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"\\d+","type":"string"},"mainPath":{"maxLength":255,"minLength":4,"nullable":false,"type":"string"},"notes":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"publishedOn":{"nullable":true,"type":"string","format":"date-time"},"createdOn":{"nullable":false,"type":"string","format":"date-time"},"createdBy":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}},"dimensions":{"oneOf":[{"type":"object","properties":{"type":{"enum":["sheet"],"nullable":false,"type":"string"},"left":{"maximum":11,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":71,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":12,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":72,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"mobileHeight":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"mobileOrder":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"mobileLeft":{"maximum":11,"nullable":true,"type":"integer","format":"int32"},"mobileCols":{"maximum":12,"minimum":1,"nullable":true,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]},{"type":"object","properties":{"type":{"enum":["card"],"nullable":false,"type":"string"},"height":{"maximum":65535,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}},"required":["type","height","order"]},{"type":"object","properties":{"type":{"enum":["report"],"nullable":false,"type":"string"},"left":{"maximum":7,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":15,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":8,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":16,"minimum":1,"nullable":false,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]},{"type":"object","properties":{"type":{"enum":["report-portrait"],"nullable":false,"type":"string"},"left":{"maximum":5,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":15,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":6,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":16,"minimum":1,"nullable":false,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]},{"type":"object","properties":{"type":{"enum":["report-landscape"],"nullable":false,"type":"string"},"left":{"maximum":7,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":10,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":8,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":11,"minimum":1,"nullable":false,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]}]},"inputs":{"maxLength":16777215,"minLength":0,"nullable":false,"type":"string"},"pagePage":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"pageVersion":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}}}}}},"previewAgent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"previewAsset":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"periodSpec":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"periodSelectorEnabled":{"nullable":false,"type":"boolean"},"defaultRefreshRate":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"createdOn":{"nullable":false,"type":"string","format":"date-time"},"createdBy":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"updatedOn":{"nullable":true,"type":"string","format":"date-time"},"updatedBy":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"pagePages":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"pageVersion":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}}}},"custom":{"nullable":false,"type":"object"}}},"published":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"page":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"title":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"components":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"pageVersion":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"template":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"boundVersion":{"nullable":true,"type":"object","properties":{"template":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"number":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"\\d+","type":"string"},"mainPath":{"maxLength":255,"minLength":4,"nullable":false,"type":"string"},"notes":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"publishedOn":{"nullable":true,"type":"string","format":"date-time"},"createdOn":{"nullable":false,"type":"string","format":"date-time"},"createdBy":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}},"dimensions":{"oneOf":[{"type":"object","properties":{"type":{"enum":["sheet"],"nullable":false,"type":"string"},"left":{"maximum":11,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":71,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":12,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":72,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"mobileHeight":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"mobileOrder":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"mobileLeft":{"maximum":11,"nullable":true,"type":"integer","format":"int32"},"mobileCols":{"maximum":12,"minimum":1,"nullable":true,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]},{"type":"object","properties":{"type":{"enum":["card"],"nullable":false,"type":"string"},"height":{"maximum":65535,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}},"required":["type","height","order"]},{"type":"object","properties":{"type":{"enum":["report"],"nullable":false,"type":"string"},"left":{"maximum":7,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":15,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":8,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":16,"minimum":1,"nullable":false,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]},{"type":"object","properties":{"type":{"enum":["report-portrait"],"nullable":false,"type":"string"},"left":{"maximum":5,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":15,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":6,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":16,"minimum":1,"nullable":false,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]},{"type":"object","properties":{"type":{"enum":["report-landscape"],"nullable":false,"type":"string"},"left":{"maximum":7,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":10,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":8,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":11,"minimum":1,"nullable":false,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]}]},"inputs":{"maxLength":16777215,"minLength":0,"nullable":false,"type":"string"},"pagePage":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"pageVersion":{"nullable":false,"type":"object"},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}}}}}},"previewAgent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"previewAsset":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"periodSpec":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"periodSelectorEnabled":{"nullable":false,"type":"boolean"},"defaultRefreshRate":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"createdOn":{"nullable":false,"type":"string","format":"date-time"},"createdBy":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"updatedOn":{"nullable":true,"type":"string","format":"date-time"},"updatedBy":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"pagePages":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"pageVersion":{"nullable":false,"type":"object"},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}}}},"custom":{"nullable":false,"type":"object"}}},"default":{"nullable":false,"type":"boolean"},"static":{"nullable":false,"type":"boolean"},"orientation":{"enum":["portrait","landscape"],"nullable":true,"type":"string"},"labels":{"type":"array","items":{"nullable":false,"type":"object","properties":{"color":{"maxLength":7,"minLength":6,"nullable":false,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"company":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}},"custom":{"nullable":false,"type":"object"}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"assetId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/assets/{assetId}/report/queue":{"post":{"tags":["AssetQueueReportList"],"summary":"AssetQueueReportList","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"assetId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"report":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"sendTo":{"type":"array","items":{"maxLength":254,"minLength":6,"nullable":false,"pattern":"^(?=.{1,254}$)(?=.{1,64}@)[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+(?:\\.[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+)*@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$","type":"string"}},"timeZone":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"start":{"nullable":false,"type":"string","format":"date-time"},"end":{"nullable":false,"type":"string","format":"date-time"},"message":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"}},"required":["report","sendTo","timeZone","start","end"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/assets/{publicId}/render":{"get":{"tags":["AssetRender"],"summary":"AssetRender","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"renderedYaml":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"}},"required":["publicId","renderedYaml"]}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/assets/{assetId}/report-schedules/{publicId}":{"get":{"tags":["AssetReportSchedule"],"summary":"AssetReportSchedule","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"asset":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"report":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"start":{"nullable":false,"type":"string","format":"date-time"},"timeZone":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"recurrence":{"oneOf":[{"type":"object","properties":{"frequency":{"enum":["weekly"],"nullable":false,"type":"string"},"interval":{"maximum":127,"minimum":-128,"nullable":false,"type":"integer","format":"int32"},"monday":{"nullable":false,"type":"boolean"},"tuesday":{"nullable":false,"type":"boolean"},"wednesday":{"nullable":false,"type":"boolean"},"thursday":{"nullable":false,"type":"boolean"},"friday":{"nullable":false,"type":"boolean"},"saturday":{"nullable":false,"type":"boolean"},"sunday":{"nullable":false,"type":"boolean"}},"required":["frequency","interval"]},{"type":"object","properties":{"frequency":{"enum":["monthly"],"nullable":false,"type":"string"},"interval":{"maximum":127,"minimum":-128,"nullable":false,"type":"integer","format":"int32"},"occurrence":{"maximum":127,"minimum":-128,"nullable":false,"type":"integer","format":"int32"},"monday":{"nullable":false,"type":"boolean"},"tuesday":{"nullable":false,"type":"boolean"},"wednesday":{"nullable":false,"type":"boolean"},"thursday":{"nullable":false,"type":"boolean"},"friday":{"nullable":false,"type":"boolean"},"saturday":{"nullable":false,"type":"boolean"},"sunday":{"nullable":false,"type":"boolean"}},"required":["frequency","interval","occurrence"]}]},"deliveryTime":{"nullable":false,"type":"string"}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"assetId","in":"path","schema":{"type":"string"}},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"patch":{"tags":["AssetReportSchedule"],"summary":"AssetReportSchedule","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"assetId","in":"path","schema":{"type":"string"}},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"timeZone":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"recurrence":{"oneOf":[{"type":"object","properties":{"frequency":{"enum":["weekly"],"nullable":false,"type":"string"},"interval":{"maximum":127,"minimum":-128,"nullable":false,"type":"integer","format":"int32"},"monday":{"nullable":false,"type":"boolean"},"tuesday":{"nullable":false,"type":"boolean"},"wednesday":{"nullable":false,"type":"boolean"},"thursday":{"nullable":false,"type":"boolean"},"friday":{"nullable":false,"type":"boolean"},"saturday":{"nullable":false,"type":"boolean"},"sunday":{"nullable":false,"type":"boolean"}},"required":["frequency","interval"]},{"type":"object","properties":{"frequency":{"enum":["monthly"],"nullable":false,"type":"string"},"interval":{"maximum":127,"minimum":-128,"nullable":false,"type":"integer","format":"int32"},"occurrence":{"maximum":127,"minimum":-128,"nullable":false,"type":"integer","format":"int32"},"monday":{"nullable":false,"type":"boolean"},"tuesday":{"nullable":false,"type":"boolean"},"wednesday":{"nullable":false,"type":"boolean"},"thursday":{"nullable":false,"type":"boolean"},"friday":{"nullable":false,"type":"boolean"},"saturday":{"nullable":false,"type":"boolean"},"sunday":{"nullable":false,"type":"boolean"}},"required":["frequency","interval","occurrence"]}]},"deliveryTime":{"nullable":false,"type":"string"},"start":{"nullable":false,"type":"string","format":"date-time"}}}}}},"security":[{"bearerToken":[]}]},"delete":{"tags":["AssetReportSchedule"],"summary":"AssetReportSchedule","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"assetId","in":"path","schema":{"type":"string"}},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/assets/{assetId}/report-schedules":{"get":{"tags":["AssetReportScheduleList"],"summary":"AssetReportScheduleList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"asset":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"report":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"start":{"nullable":false,"type":"string","format":"date-time"},"timeZone":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"recurrence":{"oneOf":[{"type":"object","properties":{"frequency":{"enum":["weekly"],"nullable":false,"type":"string"},"interval":{"maximum":127,"minimum":-128,"nullable":false,"type":"integer","format":"int32"},"monday":{"nullable":false,"type":"boolean"},"tuesday":{"nullable":false,"type":"boolean"},"wednesday":{"nullable":false,"type":"boolean"},"thursday":{"nullable":false,"type":"boolean"},"friday":{"nullable":false,"type":"boolean"},"saturday":{"nullable":false,"type":"boolean"},"sunday":{"nullable":false,"type":"boolean"}},"required":["frequency","interval"]},{"type":"object","properties":{"frequency":{"enum":["monthly"],"nullable":false,"type":"string"},"interval":{"maximum":127,"minimum":-128,"nullable":false,"type":"integer","format":"int32"},"occurrence":{"maximum":127,"minimum":-128,"nullable":false,"type":"integer","format":"int32"},"monday":{"nullable":false,"type":"boolean"},"tuesday":{"nullable":false,"type":"boolean"},"wednesday":{"nullable":false,"type":"boolean"},"thursday":{"nullable":false,"type":"boolean"},"friday":{"nullable":false,"type":"boolean"},"saturday":{"nullable":false,"type":"boolean"},"sunday":{"nullable":false,"type":"boolean"}},"required":["frequency","interval","occurrence"]}]},"deliveryTime":{"nullable":false,"type":"string"}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"assetId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"post":{"tags":["AssetReportScheduleList"],"summary":"AssetReportScheduleList","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"assetId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"report":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"start":{"nullable":false,"type":"string","format":"date-time"},"timeZone":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"recurrence":{"oneOf":[{"type":"object","properties":{"frequency":{"enum":["weekly"],"nullable":false,"type":"string"},"interval":{"maximum":127,"minimum":-128,"nullable":false,"type":"integer","format":"int32"},"monday":{"nullable":false,"type":"boolean"},"tuesday":{"nullable":false,"type":"boolean"},"wednesday":{"nullable":false,"type":"boolean"},"thursday":{"nullable":false,"type":"boolean"},"friday":{"nullable":false,"type":"boolean"},"saturday":{"nullable":false,"type":"boolean"},"sunday":{"nullable":false,"type":"boolean"}},"required":["frequency","interval"]},{"type":"object","properties":{"frequency":{"enum":["monthly"],"nullable":false,"type":"string"},"interval":{"maximum":127,"minimum":-128,"nullable":false,"type":"integer","format":"int32"},"occurrence":{"maximum":127,"minimum":-128,"nullable":false,"type":"integer","format":"int32"},"monday":{"nullable":false,"type":"boolean"},"tuesday":{"nullable":false,"type":"boolean"},"wednesday":{"nullable":false,"type":"boolean"},"thursday":{"nullable":false,"type":"boolean"},"friday":{"nullable":false,"type":"boolean"},"saturday":{"nullable":false,"type":"boolean"},"sunday":{"nullable":false,"type":"boolean"}},"required":["frequency","interval","occurrence"]}]},"deliveryTime":{"nullable":false,"type":"string"}},"required":["report","start","timeZone","recurrence","deliveryTime"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"patch":{"tags":["AssetReportScheduleList"],"summary":"AssetReportScheduleList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"assetId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"timeZone":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"recurrence":{"oneOf":[{"type":"object","properties":{"frequency":{"enum":["weekly"],"nullable":false,"type":"string"},"interval":{"maximum":127,"minimum":-128,"nullable":false,"type":"integer","format":"int32"},"monday":{"nullable":false,"type":"boolean"},"tuesday":{"nullable":false,"type":"boolean"},"wednesday":{"nullable":false,"type":"boolean"},"thursday":{"nullable":false,"type":"boolean"},"friday":{"nullable":false,"type":"boolean"},"saturday":{"nullable":false,"type":"boolean"},"sunday":{"nullable":false,"type":"boolean"}},"required":["frequency","interval"]},{"type":"object","properties":{"frequency":{"enum":["monthly"],"nullable":false,"type":"string"},"interval":{"maximum":127,"minimum":-128,"nullable":false,"type":"integer","format":"int32"},"occurrence":{"maximum":127,"minimum":-128,"nullable":false,"type":"integer","format":"int32"},"monday":{"nullable":false,"type":"boolean"},"tuesday":{"nullable":false,"type":"boolean"},"wednesday":{"nullable":false,"type":"boolean"},"thursday":{"nullable":false,"type":"boolean"},"friday":{"nullable":false,"type":"boolean"},"saturday":{"nullable":false,"type":"boolean"},"sunday":{"nullable":false,"type":"boolean"}},"required":["frequency","interval","occurrence"]}]},"deliveryTime":{"nullable":false,"type":"string"},"start":{"nullable":false,"type":"string","format":"date-time"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"delete":{"tags":["AssetReportScheduleList"],"summary":"AssetReportScheduleList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"assetId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/asset-trees":{"put":{"tags":["AssetTreeList"],"summary":"AssetTreeList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"nodes":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"nodes":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"nodes":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"reference":{"nullable":false,"type":"object"}},"required":["reference"]},{"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"resourceVariant":{"nullable":false,"type":"object"}},"required":["name","resourceVariant"]}]}},"reference":{"nullable":false,"type":"object"}},"required":["reference"]},{"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"resourceVariant":{"nullable":false,"type":"object"}},"required":["name","resourceVariant"]}]}},"reference":{"nullable":false,"type":"object"}},"required":["reference"]},{"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"resourceVariant":{"nullable":false,"type":"object"}},"required":["name","resourceVariant"]}]}},"reference":{"nullable":false,"type":"object"}},"required":["reference"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/asset-types/{publicId}":{"get":{"tags":["AssetType"],"summary":"AssetType","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"company":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"order":{"maximum":9223372036854776000,"minimum":-9223372036854776000,"nullable":false,"type":"integer","format":"int32"}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"post":{"tags":["AssetType"],"summary":"AssetType","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"order":{"maximum":9223372036854776000,"minimum":-9223372036854776000,"nullable":false,"type":"integer","format":"int32"}},"required":["name","order"]}}}},"security":[{"bearerToken":[]}]},"patch":{"tags":["AssetType"],"summary":"AssetType","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"order":{"maximum":9223372036854776000,"minimum":-9223372036854776000,"nullable":false,"type":"integer","format":"int32"}}}}}},"security":[{"bearerToken":[]}]},"delete":{"tags":["AssetType"],"summary":"AssetType","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/asset-types":{"get":{"tags":["AssetTypeList"],"summary":"AssetTypeList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"company":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"order":{"maximum":9223372036854776000,"minimum":-9223372036854776000,"nullable":false,"type":"integer","format":"int32"}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"}],"security":[{"bearerToken":[]}]},"post":{"tags":["AssetTypeList"],"summary":"AssetTypeList","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"order":{"maximum":9223372036854776000,"minimum":-9223372036854776000,"nullable":false,"type":"integer","format":"int32"}},"required":["name","order"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"patch":{"tags":["AssetTypeList"],"summary":"AssetTypeList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"order":{"maximum":9223372036854776000,"minimum":-9223372036854776000,"nullable":false,"type":"integer","format":"int32"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"delete":{"tags":["AssetTypeList"],"summary":"AssetTypeList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/audiences/{publicId}":{"get":{"tags":["Audience"],"summary":"Audience","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"custom":{"nullable":false,"type":"object"},"default":{"nullable":false,"type":"boolean"},"type":{"enum":["alarm","page","service"],"nullable":true,"type":"string"}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"patch":{"tags":["Audience"],"summary":"Audience","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"custom":{"nullable":false,"type":"object"}}}}}},"security":[{"bearerToken":[]}]},"delete":{"tags":["Audience"],"summary":"Audience","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/audiences/agent":{"get":{"tags":["AudienceAgentReferenceList"],"summary":"AudienceAgentReferenceList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"assets":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}},"audiences":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/filtersParameter"}],"security":[{"bearerToken":[]}]}},"/audiences/asset":{"get":{"tags":["AudienceAssetReferenceList"],"summary":"AudienceAssetReferenceList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"agent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"root":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"audiences":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/filtersParameter"}],"security":[{"bearerToken":[]}]}},"/audiences/{publicId}/default":{"post":{"tags":["AudienceDefault"],"summary":"AudienceDefault","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"delete":{"tags":["AudienceDefault"],"summary":"AudienceDefault","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/audiences":{"get":{"tags":["AudienceList"],"summary":"AudienceList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"custom":{"nullable":false,"type":"object"},"default":{"nullable":false,"type":"boolean"},"type":{"enum":["alarm","page","service"],"nullable":true,"type":"string"}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"}],"security":[{"bearerToken":[]}]},"post":{"tags":["AudienceList"],"summary":"AudienceList","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"type":{"enum":["alarm","page","service"],"nullable":true,"type":"string"},"custom":{"nullable":false,"type":"object"}},"required":["name"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"patch":{"tags":["AudienceList"],"summary":"AudienceList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"custom":{"nullable":false,"type":"object"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"delete":{"tags":["AudienceList"],"summary":"AudienceList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/audit-logs-export":{"get":{"tags":["AuditLogExport"],"summary":"AuditLogExport","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/filtersParameter"}],"security":[{"bearerToken":[]}]}},"/audit-logs":{"get":{"tags":["AuditLogList"],"summary":"AuditLogList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":24,"minLength":24,"nullable":false,"type":"string"},"action":{"enum":["CREATE","UPDATE","DELETE","TRIGGER"],"nullable":false,"type":"string"},"topic":{"nullable":false,"type":"object","properties":{"company":{"maxLength":24,"minLength":24,"nullable":false,"type":"string"},"user":{"maxLength":12,"minLength":12,"nullable":true,"type":"string"},"agent":{"maxLength":12,"minLength":12,"nullable":true,"type":"string"},"asset":{"maxLength":12,"minLength":12,"nullable":true,"type":"string"}}},"time":{"nullable":false,"type":"string","format":"date-time"},"request":{"nullable":false,"type":"object","properties":{"ipAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"fromName":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"geoLocation":{"nullable":true,"type":"object","properties":{"latitude":{"nullable":false,"type":"string"},"longitude":{"nullable":false,"type":"string"},"country":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"city":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}},"actor":{"nullable":false,"type":"object","properties":{"type":{"enum":["agent","support","client","webshopintegration","scim-provisioning"],"nullable":false,"type":"string"},"resource":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":24,"minLength":2,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"type":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}},"application":{"nullable":true,"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"target":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"before":{"nullable":true},"after":{"nullable":true}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/filtersParameter"}],"security":[{"bearerToken":[]}]}},"/auth-tokens/ai-chat":{"post":{"tags":["AuthTokenAiChatList"],"summary":"AuthTokenAiChatList","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"secretId":{"maxLength":64000,"minLength":1,"nullable":false,"type":"string"},"expiresOn":{"nullable":false,"type":"string","format":"date-time"}}}}}}}}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"expiresIn":{"maximum":3600,"minimum":60,"nullable":false,"type":"integer","format":"int32"}},"required":["expiresIn"]}}}},"security":[{"bearerToken":[]}]}},"/auth-tokens/cns":{"post":{"tags":["AuthTokenChangeNotificationsList"],"summary":"AuthTokenChangeNotificationsList","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"secretId":{"maxLength":64000,"minLength":1,"nullable":false,"type":"string"},"expiresOn":{"nullable":false,"type":"string","format":"date-time"}}}}}}}}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"expiresIn":{"maximum":3600,"minimum":60,"nullable":false,"type":"integer","format":"int32"}},"required":["expiresIn"]}}}},"security":[{"bearerToken":[]}]}},"/auth-tokens/data":{"post":{"tags":["AuthTokenDataList"],"summary":"AuthTokenDataList","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"secretId":{"maxLength":64000,"minLength":1,"nullable":false,"type":"string"},"expiresOn":{"nullable":false,"type":"string","format":"date-time"}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"agents":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}},"expiresIn":{"maximum":3600,"minimum":60,"nullable":false,"type":"integer","format":"int32"}},"required":["agents","expiresIn"]}}}},"security":[{"bearerToken":[]}]}},"/auth-tokens":{"get":{"tags":["AuthTokenList"],"summary":"AuthTokenList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"purpose":{"enum":["change-notifications","data","ai-chat"],"nullable":false,"type":"string"},"expiresOn":{"nullable":false,"type":"string","format":"date-time"},"created":{"nullable":false,"type":"object","properties":{"ip":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"on":{"nullable":false,"type":"string","format":"date-time"},"userAgent":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"}}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"}],"security":[{"bearerToken":[]}]}},"/backend-component-function-call":{"post":{"tags":["BackendComponentFunctionCall"],"summary":"BackendComponentFunctionCall","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"value":{"nullable":false}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"template":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"arguments":{"nullable":true}},"required":["template","name"]}}}},"security":[{"bearerToken":[]}]}},"/backend-component-message-subscriptions/{publicId}":{"get":{"tags":["BackendComponentMessageSubscription"],"summary":"BackendComponentMessageSubscription","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"createdOn":{"nullable":false,"type":"string","format":"date-time"},"template":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"company":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"delete":{"tags":["BackendComponentMessageSubscription"],"summary":"BackendComponentMessageSubscription","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/backend-component-message-subscriptions":{"get":{"tags":["BackendComponentMessageSubscriptionList"],"summary":"BackendComponentMessageSubscriptionList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"createdOn":{"nullable":false,"type":"string","format":"date-time"},"template":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"company":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"}],"security":[{"bearerToken":[]}]},"post":{"tags":["BackendComponentMessageSubscriptionList"],"summary":"BackendComponentMessageSubscriptionList","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"template":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"company":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}},"required":["template","company"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"delete":{"tags":["BackendComponentMessageSubscriptionList"],"summary":"BackendComponentMessageSubscriptionList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/backend-component-message-subscriptions/{publicId}/triggers":{"get":{"tags":["BackendComponentMessageTriggerList"],"summary":"BackendComponentMessageTriggerList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":36,"minLength":36,"nullable":false,"type":"string","format":"uuid"},"lastTry":{"nullable":true,"type":"string","format":"date-time"},"nextTry":{"nullable":true,"type":"string","format":"date-time"},"ok":{"nullable":false,"type":"boolean"},"retrying":{"nullable":false,"type":"boolean"},"status":{"maxLength":100,"minLength":2,"nullable":true,"type":"string"},"tryCount":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"subscription":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/backend-component-templates/{publicId}":{"get":{"tags":["BackendComponentTemplate"],"summary":"BackendComponentTemplate","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"company":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":24,"minLength":24,"nullable":false,"pattern":"(\\d{4}-){4}\\d{4}","type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"draft":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"published":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"configuredVersion":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"number":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"\\d+","type":"string"}}},"apiApplication":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"custom":{"nullable":false,"type":"object"}}},"accessTokenScope":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"private":{"nullable":false,"type":"boolean"},"ownerName":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"defaultConfigValues":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"configConfidentiality":{"enum":["public","secret"],"nullable":false,"type":"string"}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"patch":{"tags":["BackendComponentTemplate"],"summary":"BackendComponentTemplate","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"accessTokenScope":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"defaultConfigValues":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"configConfidentiality":{"enum":["public","secret"],"nullable":false,"type":"string"}}}}}},"security":[{"bearerToken":[]}]}},"/backend-component-template-configs/{publicId}":{"get":{"tags":["BackendComponentTemplateConfig"],"summary":"BackendComponentTemplateConfig","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"template":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"company":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"values":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"allowDraft":{"nullable":false,"type":"boolean"},"pinnedVersion":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"enabled":{"nullable":false,"type":"boolean"}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"patch":{"tags":["BackendComponentTemplateConfig"],"summary":"BackendComponentTemplateConfig","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"values":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"}}}}}},"security":[{"bearerToken":[]}]}},"/backend-component-template-configs":{"get":{"tags":["BackendComponentTemplateConfigList"],"summary":"BackendComponentTemplateConfigList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"template":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"company":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"values":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"allowDraft":{"nullable":false,"type":"boolean"},"pinnedVersion":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"enabled":{"nullable":false,"type":"boolean"}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"}],"security":[{"bearerToken":[]}]},"post":{"tags":["BackendComponentTemplateConfigList"],"summary":"BackendComponentTemplateConfigList","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"template":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"values":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"}},"required":["template"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"patch":{"tags":["BackendComponentTemplateConfigList"],"summary":"BackendComponentTemplateConfigList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"values":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/backend-component-templates/{publicId}/logs":{"get":{"tags":["BackendComponentTemplateDownloadLogs"],"summary":"BackendComponentTemplateDownloadLogs","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/backend-component-templates":{"get":{"tags":["BackendComponentTemplateList"],"summary":"BackendComponentTemplateList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"company":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":24,"minLength":24,"nullable":false,"pattern":"(\\d{4}-){4}\\d{4}","type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"draft":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"published":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"configuredVersion":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"number":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"\\d+","type":"string"}}},"apiApplication":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"custom":{"nullable":false,"type":"object"}}},"accessTokenScope":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"private":{"nullable":false,"type":"boolean"},"ownerName":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"defaultConfigValues":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"configConfidentiality":{"enum":["public","secret"],"nullable":false,"type":"string"}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"}],"security":[{"bearerToken":[]}]},"post":{"tags":["BackendComponentTemplateList"],"summary":"BackendComponentTemplateList","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"accessTokenScope":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"defaultConfigValues":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"configConfidentiality":{"enum":["public","secret"],"nullable":false,"type":"string"}},"required":["name"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"patch":{"tags":["BackendComponentTemplateList"],"summary":"BackendComponentTemplateList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"accessTokenScope":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"defaultConfigValues":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"configConfidentiality":{"enum":["public","secret"],"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/backend-component-template-shares/{publicId}":{"get":{"tags":["BackendComponentTemplateShare"],"summary":"BackendComponentTemplateShare","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"company":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":24,"minLength":24,"nullable":false,"pattern":"(\\d{4}-){4}\\d{4}","type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"template":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/backend-component-template-shares":{"get":{"tags":["BackendComponentTemplateShareList"],"summary":"BackendComponentTemplateShareList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"company":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":24,"minLength":24,"nullable":false,"pattern":"(\\d{4}-){4}\\d{4}","type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"template":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"}],"security":[{"bearerToken":[]}]},"post":{"tags":["BackendComponentTemplateShareList"],"summary":"BackendComponentTemplateShareList","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"company":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"template":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}},"required":["company","template"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/backend-component-template-versions/{publicId}":{"get":{"tags":["BackendComponentTemplateVersion"],"summary":"BackendComponentTemplateVersion","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"template":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"number":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"\\d+","type":"string"},"publishedOn":{"nullable":true,"type":"string","format":"date-time"},"createdOn":{"nullable":false,"type":"string","format":"date-time"},"createdBy":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/backend-component-template-versions":{"get":{"tags":["BackendComponentTemplateVersionList"],"summary":"BackendComponentTemplateVersionList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"template":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"number":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"\\d+","type":"string"},"publishedOn":{"nullable":true,"type":"string","format":"date-time"},"createdOn":{"nullable":false,"type":"string","format":"date-time"},"createdBy":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"}],"security":[{"bearerToken":[]}]}},"/backend-component-templates/{publicId}/version-upload":{"post":{"tags":["BackendComponentTemplateVersionUpload"],"summary":"BackendComponentTemplateVersionUpload","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"number":{"maxLength":64,"minLength":1,"nullable":false,"type":"string"},"readyTime":{"nullable":false,"type":"string","format":"date-time"}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/zip":{"schema":{"type":"string","format":"binary"}}},"description":"This endpoint requires a zip file upload"},"security":[{"bearerToken":[]}]}},"/brandings":{"get":{"tags":["BrandingList"],"summary":"BrandingList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"fqdn":{"maxLength":253,"minLength":4,"nullable":true,"pattern":".+(\\..[^.]+)","type":"string"},"theme":{"nullable":true,"type":"object","properties":{"primaryColor":{"maxLength":7,"minLength":6,"nullable":false,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"primaryTextColor":{"maxLength":7,"minLength":6,"nullable":false,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"accentColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"accentTextColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"headerColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"headerLineColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"menuColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"menuTextColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"pageColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"pageTextColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"cardColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"cardTextColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"logoHasBackgroundColor":{"nullable":false,"type":"boolean"},"logoOnHeaderColorSpec":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"}}},"appleTouchIcon":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"favicon":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"logo":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"logoDark":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"appleAppStoreLink":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"googlePlayStoreLink":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"landingPageComponentTemplate":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"company":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"version":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"author":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"licence":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"url":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"sheetSettings":{"nullable":true,"type":"object","properties":{"minCols":{"maximum":11,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"defaultCols":{"maximum":11,"minimum":1,"nullable":true,"type":"integer","format":"int32"},"maxCols":{"maximum":11,"minimum":1,"nullable":true,"type":"integer","format":"int32"},"minRows":{"maximum":11,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"defaultRows":{"maximum":11,"minimum":1,"nullable":true,"type":"integer","format":"int32"},"maxRows":{"maximum":11,"minimum":1,"nullable":true,"type":"integer","format":"int32"}}},"cardSettings":{"nullable":true,"type":"object","properties":{"minHeight":{"maximum":65535,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"defaultHeight":{"maximum":65535,"minimum":1,"nullable":true,"type":"integer","format":"int32"},"maxHeight":{"maximum":65535,"minimum":1,"nullable":true,"type":"integer","format":"int32"}}},"inputs":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"draft":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"published":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"category":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}}},"configuredVersion":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"number":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"\\d+","type":"string"},"mainPath":{"maxLength":255,"minLength":4,"nullable":false,"type":"string"}}},"backendComponent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"static":{"nullable":false,"type":"boolean"},"intent":{"type":"array","items":{"enum":["asset-configuration","landing-page","main-page"],"nullable":false,"type":"string"}},"private":{"nullable":false,"type":"boolean"}}},"custom":{"nullable":false,"type":"object"}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"}]}},"/companies/{publicId}":{"get":{"tags":["Company"],"summary":"Company","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":24,"minLength":24,"nullable":false,"pattern":"(\\d{4}-){4}\\d{4}","type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"custom":{"nullable":false,"type":"object"},"branding":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"fqdn":{"maxLength":253,"minLength":4,"nullable":true,"pattern":".+(\\..[^.]+)","type":"string"},"theme":{"nullable":true,"type":"object","properties":{"primaryColor":{"maxLength":7,"minLength":6,"nullable":false,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"primaryTextColor":{"maxLength":7,"minLength":6,"nullable":false,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"accentColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"accentTextColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"headerColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"headerLineColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"menuColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"menuTextColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"pageColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"pageTextColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"cardColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"cardTextColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"logoHasBackgroundColor":{"nullable":false,"type":"boolean"},"logoOnHeaderColorSpec":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"}}},"appleTouchIcon":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"favicon":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"logo":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"logoDark":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"appleAppStoreLink":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"googlePlayStoreLink":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"landingPageComponentTemplate":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"company":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"version":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"author":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"licence":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"url":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"sheetSettings":{"nullable":true,"type":"object","properties":{"minCols":{"maximum":11,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"defaultCols":{"maximum":11,"minimum":1,"nullable":true,"type":"integer","format":"int32"},"maxCols":{"maximum":11,"minimum":1,"nullable":true,"type":"integer","format":"int32"},"minRows":{"maximum":11,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"defaultRows":{"maximum":11,"minimum":1,"nullable":true,"type":"integer","format":"int32"},"maxRows":{"maximum":11,"minimum":1,"nullable":true,"type":"integer","format":"int32"}}},"cardSettings":{"nullable":true,"type":"object","properties":{"minHeight":{"maximum":65535,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"defaultHeight":{"maximum":65535,"minimum":1,"nullable":true,"type":"integer","format":"int32"},"maxHeight":{"maximum":65535,"minimum":1,"nullable":true,"type":"integer","format":"int32"}}},"inputs":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"draft":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"published":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"category":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}}},"configuredVersion":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"number":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"\\d+","type":"string"},"mainPath":{"maxLength":255,"minLength":4,"nullable":false,"type":"string"}}},"backendComponent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"static":{"nullable":false,"type":"boolean"},"intent":{"type":"array","items":{"enum":["asset-configuration","landing-page","main-page"],"nullable":false,"type":"string"}},"private":{"nullable":false,"type":"boolean"}}},"custom":{"nullable":false,"type":"object"}}},"customTermsOfUse":{"enum":["sector","company","disabled"],"nullable":false,"type":"string"},"customPrivacyStatement":{"enum":["sector","company","disabled"],"nullable":false,"type":"string"},"latestTermsOfUse":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"company":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"latest":{"nullable":true,"type":"boolean"},"version":{"maxLength":5,"minLength":1,"nullable":true,"type":"string"},"publishedOn":{"nullable":true,"type":"string","format":"date-time"},"downloadUrl":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"type":{"enum":["termsofuse","privacystatement"],"nullable":false,"type":"string"},"languages":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"languageCode":{"maxLength":2,"minLength":2,"nullable":false,"type":"string"},"body":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"updateSummary":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"policy":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}}}},"latestPrivacyStatement":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"company":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"latest":{"nullable":true,"type":"boolean"},"version":{"maxLength":5,"minLength":1,"nullable":true,"type":"string"},"publishedOn":{"nullable":true,"type":"string","format":"date-time"},"downloadUrl":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"type":{"enum":["termsofuse","privacystatement"],"nullable":false,"type":"string"},"languages":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"languageCode":{"maxLength":2,"minLength":2,"nullable":false,"type":"string"},"body":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"updateSummary":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"policy":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"delete":{"tags":["Company"],"summary":"Company","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/companies/{publicId}/branding":{"get":{"tags":["CompanyBranding"],"summary":"CompanyBranding","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"fqdn":{"maxLength":253,"minLength":4,"nullable":true,"pattern":".+(\\..[^.]+)","type":"string"},"theme":{"nullable":true,"type":"object","properties":{"primaryColor":{"maxLength":7,"minLength":6,"nullable":false,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"primaryTextColor":{"maxLength":7,"minLength":6,"nullable":false,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"accentColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"accentTextColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"headerColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"headerLineColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"menuColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"menuTextColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"pageColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"pageTextColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"cardColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"cardTextColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"logoHasBackgroundColor":{"nullable":false,"type":"boolean"},"logoOnHeaderColorSpec":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"}}},"appleTouchIcon":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"favicon":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"logo":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"logoDark":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"appleAppStoreLink":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"googlePlayStoreLink":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"landingPageComponentTemplate":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"company":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"version":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"author":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"licence":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"url":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"sheetSettings":{"nullable":true,"type":"object","properties":{"minCols":{"maximum":11,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"defaultCols":{"maximum":11,"minimum":1,"nullable":true,"type":"integer","format":"int32"},"maxCols":{"maximum":11,"minimum":1,"nullable":true,"type":"integer","format":"int32"},"minRows":{"maximum":11,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"defaultRows":{"maximum":11,"minimum":1,"nullable":true,"type":"integer","format":"int32"},"maxRows":{"maximum":11,"minimum":1,"nullable":true,"type":"integer","format":"int32"}}},"cardSettings":{"nullable":true,"type":"object","properties":{"minHeight":{"maximum":65535,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"defaultHeight":{"maximum":65535,"minimum":1,"nullable":true,"type":"integer","format":"int32"},"maxHeight":{"maximum":65535,"minimum":1,"nullable":true,"type":"integer","format":"int32"}}},"inputs":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"draft":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"published":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"category":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}}},"configuredVersion":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"number":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"\\d+","type":"string"},"mainPath":{"maxLength":255,"minLength":4,"nullable":false,"type":"string"}}},"backendComponent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"static":{"nullable":false,"type":"boolean"},"intent":{"type":"array","items":{"enum":["asset-configuration","landing-page","main-page"],"nullable":false,"type":"string"}},"private":{"nullable":false,"type":"boolean"}}},"custom":{"nullable":false,"type":"object"}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}]}},"/companies":{"get":{"tags":["CompanyList"],"summary":"CompanyList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":24,"minLength":24,"nullable":false,"pattern":"(\\d{4}-){4}\\d{4}","type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"custom":{"nullable":false,"type":"object"},"branding":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"fqdn":{"maxLength":253,"minLength":4,"nullable":true,"pattern":".+(\\..[^.]+)","type":"string"},"theme":{"nullable":true,"type":"object","properties":{"primaryColor":{"maxLength":7,"minLength":6,"nullable":false,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"primaryTextColor":{"maxLength":7,"minLength":6,"nullable":false,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"accentColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"accentTextColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"headerColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"headerLineColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"menuColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"menuTextColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"pageColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"pageTextColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"cardColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"cardTextColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"logoHasBackgroundColor":{"nullable":false,"type":"boolean"},"logoOnHeaderColorSpec":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"}}},"appleTouchIcon":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"favicon":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"logo":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"logoDark":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"appleAppStoreLink":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"googlePlayStoreLink":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"landingPageComponentTemplate":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"company":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"version":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"author":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"licence":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"url":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"sheetSettings":{"nullable":true,"type":"object","properties":{"minCols":{"maximum":11,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"defaultCols":{"maximum":11,"minimum":1,"nullable":true,"type":"integer","format":"int32"},"maxCols":{"maximum":11,"minimum":1,"nullable":true,"type":"integer","format":"int32"},"minRows":{"maximum":11,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"defaultRows":{"maximum":11,"minimum":1,"nullable":true,"type":"integer","format":"int32"},"maxRows":{"maximum":11,"minimum":1,"nullable":true,"type":"integer","format":"int32"}}},"cardSettings":{"nullable":true,"type":"object","properties":{"minHeight":{"maximum":65535,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"defaultHeight":{"maximum":65535,"minimum":1,"nullable":true,"type":"integer","format":"int32"},"maxHeight":{"maximum":65535,"minimum":1,"nullable":true,"type":"integer","format":"int32"}}},"inputs":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"draft":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"published":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"category":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}}},"configuredVersion":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"number":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"\\d+","type":"string"},"mainPath":{"maxLength":255,"minLength":4,"nullable":false,"type":"string"}}},"backendComponent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"static":{"nullable":false,"type":"boolean"},"intent":{"type":"array","items":{"enum":["asset-configuration","landing-page","main-page"],"nullable":false,"type":"string"}},"private":{"nullable":false,"type":"boolean"}}},"custom":{"nullable":false,"type":"object"}}},"customTermsOfUse":{"enum":["sector","company","disabled"],"nullable":false,"type":"string"},"customPrivacyStatement":{"enum":["sector","company","disabled"],"nullable":false,"type":"string"},"latestTermsOfUse":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"company":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"latest":{"nullable":true,"type":"boolean"},"version":{"maxLength":5,"minLength":1,"nullable":true,"type":"string"},"publishedOn":{"nullable":true,"type":"string","format":"date-time"},"downloadUrl":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"type":{"enum":["termsofuse","privacystatement"],"nullable":false,"type":"string"},"languages":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"languageCode":{"maxLength":2,"minLength":2,"nullable":false,"type":"string"},"body":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"updateSummary":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"policy":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}}}},"latestPrivacyStatement":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"company":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"latest":{"nullable":true,"type":"boolean"},"version":{"maxLength":5,"minLength":1,"nullable":true,"type":"string"},"publishedOn":{"nullable":true,"type":"string","format":"date-time"},"downloadUrl":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"type":{"enum":["termsofuse","privacystatement"],"nullable":false,"type":"string"},"languages":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"languageCode":{"maxLength":2,"minLength":2,"nullable":false,"type":"string"},"body":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"updateSummary":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"policy":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}}}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"}],"security":[{"bearerToken":[]}]},"post":{"tags":["CompanyList"],"summary":"CompanyList","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"country":{"maxLength":2,"minLength":2,"nullable":false,"pattern":"[A-Z]{2}","type":"string"},"termsOfUsePolicy":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}},"required":["name"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"delete":{"tags":["CompanyList"],"summary":"CompanyList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":24,"minLength":24,"nullable":false,"pattern":"(\\d{4}-){4}\\d{4}","type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/companies/{companyId}/privacy-statements/{publicId}/download":{"get":{"tags":["CompanyPrivacyStatementDownload"],"summary":"CompanyPrivacyStatementDownload","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"companyId","in":"path","schema":{"type":"string"}},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}]}},"/companies/privacy-statement-languages":{"patch":{"tags":["CompanyPrivacyStatementLanguage"],"summary":"CompanyPrivacyStatementLanguage","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"body":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"}},"required":["body"]}}}},"security":[{"bearerToken":[]}]}},"/companies/{publicId}/privacy-statements":{"get":{"tags":["CompanyPrivacyStatementList"],"summary":"CompanyPrivacyStatementList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"company":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"latest":{"nullable":true,"type":"boolean"},"version":{"maxLength":5,"minLength":1,"nullable":true,"type":"string"},"publishedOn":{"nullable":true,"type":"string","format":"date-time"},"downloadUrl":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"type":{"enum":["termsofuse","privacystatement"],"nullable":false,"type":"string"},"languages":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"languageCode":{"maxLength":2,"minLength":2,"nullable":false,"type":"string"},"body":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"updateSummary":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"policy":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}]}},"/companies/privacy-statements/publish":{"post":{"tags":["CompanyPrivacyStatementPublish"],"summary":"CompanyPrivacyStatementPublish","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"security":[{"bearerToken":[]}]}},"/companies/terms-of-use-policies/{publicId}/accept":{"post":{"tags":["CompanyTermsOfUsePolicyAccept"],"summary":"CompanyTermsOfUsePolicyAccept","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/companies/{companyId}/terms-of-use-policies/{publicId}/download":{"get":{"tags":["CompanyTermsOfUsePolicyDownload"],"summary":"CompanyTermsOfUsePolicyDownload","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"companyId","in":"path","schema":{"type":"string"}},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}]}},"/companies/terms-of-use-policy-languages":{"patch":{"tags":["CompanyTermsOfUsePolicyLanguage"],"summary":"CompanyTermsOfUsePolicyLanguage","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"body":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"}},"required":["body"]}}}},"security":[{"bearerToken":[]}]}},"/companies/{publicId}/terms-of-use-policies":{"get":{"tags":["CompanyTermsOfUsePolicyList"],"summary":"CompanyTermsOfUsePolicyList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"company":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"latest":{"nullable":true,"type":"boolean"},"version":{"maxLength":5,"minLength":1,"nullable":true,"type":"string"},"publishedOn":{"nullable":true,"type":"string","format":"date-time"},"downloadUrl":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"type":{"enum":["termsofuse","privacystatement"],"nullable":false,"type":"string"},"languages":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"languageCode":{"maxLength":2,"minLength":2,"nullable":false,"type":"string"},"body":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"updateSummary":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"policy":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}]}},"/companies/terms-of-use-policies/publish":{"post":{"tags":["CompanyTermsOfUsePolicyPublish"],"summary":"CompanyTermsOfUsePolicyPublish","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"security":[{"bearerToken":[]}]}},"/controlled-devices/{publicId}":{"get":{"tags":["ControlledDevice"],"summary":"ControlledDevice","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"deviceId":{"maxLength":128,"minLength":1,"nullable":false,"type":"string"},"type":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"additionalSubnets":{"nullable":false,"type":"boolean"},"allowDataPublishing":{"nullable":false,"type":"boolean"},"allowDemoDevice":{"nullable":false,"type":"boolean"},"allowTemplating":{"nullable":false,"type":"boolean"},"allowReboot":{"nullable":false,"type":"boolean"},"configPush":{"nullable":false,"type":"boolean"},"configFileFormat":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"customServers":{"nullable":false,"type":"boolean"},"deviceIdFormat":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"httpProxyPort":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"latestFirmwareFile":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"code":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"notes":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"agentType":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"type":{"enum":["firmware"],"nullable":false,"type":"string"},"latest":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"offlineConfiguration":{"nullable":false,"type":"boolean"},"openvpnConfigMultiUse":{"nullable":false,"type":"boolean"},"purchasePrice":{"nullable":false,"type":"object","properties":{"gratis":{"nullable":false,"type":"boolean"}}},"router":{"nullable":false,"type":"boolean"},"stunnelSupport":{"nullable":false,"type":"boolean"},"wanPortForwardings":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"},"hasSecondWanPort":{"nullable":false,"type":"boolean"}}},"config":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"configFileServer":{"maxLength":4294967295,"minLength":0,"nullable":true,"type":"string"},"configPushedOn":{"nullable":true,"type":"string","format":"date-time"},"configFileReported":{"maxLength":4294967295,"minLength":0,"nullable":true,"type":"string"},"configFileReportedWlanKeyEnabled":{"nullable":false,"type":"boolean"},"configFileReportedCellularPasswordEnabled":{"nullable":false,"type":"boolean"},"configReportedOn":{"nullable":true,"type":"string","format":"date-time"},"differentConfigs":{"nullable":false,"type":"boolean"},"differentWanConfigs":{"nullable":false,"type":"boolean"},"stewardConfigFileServer":{"maxLength":4294967295,"minLength":0,"nullable":true,"type":"string"},"stewardConfigFileReported":{"maxLength":4294967295,"minLength":0,"nullable":true,"type":"string"},"stewardConfigReportedOn":{"nullable":true,"type":"string","format":"date-time"},"differentStewardConfigs":{"nullable":false,"type":"boolean"},"routerLan":{"nullable":false,"type":"object","properties":{"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"ipAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"netMask":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"network":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"dhcpServerEnabled":{"nullable":false,"type":"boolean"},"dhcpServerRangeFrom":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"dhcpServerRangeTo":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"gatewayLessRouting":{"nullable":false,"type":"boolean"},"forwardLanWan":{"enum":["neither","public","private","both"],"nullable":false,"type":"string"},"forwardLanWan2":{"enum":["neither","public","private","both"],"nullable":false,"type":"string"},"wlanEnable":{"nullable":true,"type":"boolean"},"wlanSsid":{"maxLength":32,"minLength":0,"nullable":true,"type":"string"},"wlanKey":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"wlanChannel":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"bacnetBbmd":{"type":"array","items":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}},"udpBroadcastRelayPort":{"type":"array","items":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}}}},"routerVpn":{"nullable":false,"type":"object","properties":{"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"sourceNatEnabled":{"nullable":false,"type":"boolean"}}},"routerWan":{"nullable":false,"type":"object","properties":{"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"multiwanPolicy":{"enum":["eth_cell_wifi","cell_eth_wifi","eth_wifi_cell","wifi_eth_cell","cell_wifi_eth","wifi_cell_eth"],"nullable":true,"type":"string"},"ipUseDhcp":{"nullable":true,"type":"boolean"},"ipAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"ipGateway":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"ipNetMask":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"dnsServers":{"type":"array","items":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}},"dnsRebindProtectionEnabled":{"nullable":true,"type":"boolean"},"cellularApn":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"cellularPincode":{"maxLength":8,"minLength":0,"nullable":true,"type":"string"},"cellularMtu":{"maximum":1500,"minimum":576,"nullable":true,"type":"integer","format":"int32"},"digitalInputMode":{"enum":["disable_vpn_high","disable_vpn_low","disable_wan_high","disable_wan_low"],"nullable":true,"type":"string"},"wanTrackInterval":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"wanTrackIps":{"type":"array","items":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}},"wlanTrackInterval":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"wlanTrackIps":{"type":"array","items":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}},"cellularTrackInterval":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"cellularTrackIps":{"type":"array","items":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}},"httpProxyAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"httpProxyPort":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"httpProxyAuthentication":{"enum":["none","basic","ntlm"],"nullable":true,"type":"string"},"httpProxyUsername":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"httpProxyIsSocks5":{"nullable":true,"type":"boolean"},"wlanSsid":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"wlanIpUseDhcp":{"nullable":true,"type":"boolean"},"wlanIpAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"wlanIpGateway":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"wlanIpNetMask":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"wlanDnsServers":{"type":"array","items":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}},"cellularUsername":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"}}},"routerDisplay":{"nullable":false,"type":"object","properties":{"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"lockEnabled":{"nullable":false,"type":"boolean"},"lockCode":{"maxLength":4,"minLength":4,"nullable":true,"pattern":"[0-9]+","type":"string"}}},"routerAdditionalSubnets":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"networkAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"networkMask":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"gatewayAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}},"routerPortForwards":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"interface":{"enum":["VPN","WAN","WAN2"],"nullable":false,"type":"string"},"targetIpAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"targetPort":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"externalPort":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}},"routerNtpServers":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"server":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}}},"macAddress":{"maxLength":17,"minLength":1,"nullable":false,"type":"string"},"serialNumber":{"maxLength":128,"minLength":1,"nullable":false,"type":"string"},"company":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":24,"minLength":24,"nullable":false,"pattern":"(\\d{4}-){4}\\d{4}","type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"activeStatus":{"enum":["active","inactive"],"nullable":false,"type":"string"},"activeVpnSession":{"nullable":true,"type":"object","properties":{"rscServer":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"vpnRange":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"supportedLayers":{"type":"array","items":{"enum":["tun","tap"],"nullable":false,"type":"string"}},"location":{"nullable":false,"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"latitude":{"nullable":false,"type":"string"},"longitude":{"nullable":false,"type":"string"}}}}},"startedOn":{"nullable":false,"type":"string","format":"date-time"},"sessionName":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"vpnAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"closed":{"nullable":false,"type":"boolean"}}},"vpnChangedOn":{"nullable":true,"type":"string","format":"date-time"},"mqttChangedOn":{"nullable":true,"type":"string","format":"date-time"},"mdrServer":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"lastSeenAgentUserAgent":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"value":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"configName":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"configVersion":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"hardware":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"hardwareCode":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"hardwareVersion":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"firmwareVersion":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"osName":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"osVersion":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"appName":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"appVersion":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"packageName":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"packageVersion":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"libixagentVersion":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"libixloggerVersion":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"logOnTrigger":{"nullable":false,"type":"boolean"},"alarming":{"nullable":false,"type":"boolean"},"dataMonitoring":{"nullable":false,"type":"boolean"},"wifi":{"nullable":false,"type":"boolean"},"remoteFirmwareUpgrade":{"nullable":false,"type":"boolean"},"staticMapping":{"nullable":false,"type":"boolean"},"stewardConfigPush":{"nullable":false,"type":"boolean"},"wanInterfaceEth0":{"nullable":false,"type":"boolean"},"wanInterfaceWifi0":{"nullable":false,"type":"boolean"},"wanInterfaceCell0":{"enum":["3G","4G","neither"],"nullable":false,"type":"string"},"multiWan":{"nullable":false,"type":"boolean"},"openvpnVersion":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"openvpnOccEnabled":{"nullable":false,"type":"boolean"},"openvpnOpensslVersion":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"}}},"vpnLocked":{"nullable":false,"type":"boolean"},"webAccessLocked":{"nullable":false,"type":"boolean"}}},"memberships":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"controlledDevice":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"group":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"patch":{"tags":["ControlledDevice"],"summary":"ControlledDevice","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"vpnLocked":{"nullable":false,"type":"boolean"},"webAccessLocked":{"nullable":false,"type":"boolean"}}}}}}}},"security":[{"bearerToken":[]}]},"post":{"tags":["ControlledDevice"],"summary":"ControlledDevice","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"device":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"controlKey":{"maxLength":11,"minLength":11,"nullable":false,"pattern":"[B-DF-HJ-NP-TV-Z]{3}-[1-9]{3}-[B-DF-HJ-NP-TV-Z]{3}","type":"string"},"groups":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}},"required":["name","device","controlKey"]}}}},"security":[{"bearerToken":[]}]},"delete":{"tags":["ControlledDevice"],"summary":"ControlledDevice","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/controlled-devices/{publicId}/audit-logs":{"get":{"tags":["ControlledDeviceAuditLogList"],"summary":"ControlledDeviceAuditLogList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":24,"minLength":24,"nullable":false,"type":"string"},"action":{"enum":["CREATE","UPDATE","DELETE","TRIGGER"],"nullable":false,"type":"string"},"topic":{"nullable":false,"type":"object","properties":{"company":{"maxLength":24,"minLength":24,"nullable":false,"type":"string"},"user":{"maxLength":12,"minLength":12,"nullable":true,"type":"string"},"agent":{"maxLength":12,"minLength":12,"nullable":true,"type":"string"},"asset":{"maxLength":12,"minLength":12,"nullable":true,"type":"string"}}},"time":{"nullable":false,"type":"string","format":"date-time"},"request":{"nullable":false,"type":"object","properties":{"ipAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"fromName":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"geoLocation":{"nullable":true,"type":"object","properties":{"latitude":{"nullable":false,"type":"string"},"longitude":{"nullable":false,"type":"string"},"country":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"city":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}},"actor":{"nullable":false,"type":"object","properties":{"type":{"enum":["agent","support","client","webshopintegration","scim-provisioning"],"nullable":false,"type":"string"},"resource":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":24,"minLength":2,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"type":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}},"application":{"nullable":true,"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"target":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"before":{"nullable":true},"after":{"nullable":true}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/controlled-devices":{"get":{"tags":["ControlledDeviceList"],"summary":"ControlledDeviceList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"deviceId":{"maxLength":128,"minLength":1,"nullable":false,"type":"string"},"type":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"additionalSubnets":{"nullable":false,"type":"boolean"},"allowDataPublishing":{"nullable":false,"type":"boolean"},"allowDemoDevice":{"nullable":false,"type":"boolean"},"allowTemplating":{"nullable":false,"type":"boolean"},"allowReboot":{"nullable":false,"type":"boolean"},"configPush":{"nullable":false,"type":"boolean"},"configFileFormat":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"customServers":{"nullable":false,"type":"boolean"},"deviceIdFormat":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"httpProxyPort":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"latestFirmwareFile":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"code":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"notes":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"agentType":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"type":{"enum":["firmware"],"nullable":false,"type":"string"},"latest":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"offlineConfiguration":{"nullable":false,"type":"boolean"},"openvpnConfigMultiUse":{"nullable":false,"type":"boolean"},"purchasePrice":{"nullable":false,"type":"object","properties":{"gratis":{"nullable":false,"type":"boolean"}}},"router":{"nullable":false,"type":"boolean"},"stunnelSupport":{"nullable":false,"type":"boolean"},"wanPortForwardings":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"},"hasSecondWanPort":{"nullable":false,"type":"boolean"}}},"config":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"configFileServer":{"maxLength":4294967295,"minLength":0,"nullable":true,"type":"string"},"configPushedOn":{"nullable":true,"type":"string","format":"date-time"},"configFileReported":{"maxLength":4294967295,"minLength":0,"nullable":true,"type":"string"},"configFileReportedWlanKeyEnabled":{"nullable":false,"type":"boolean"},"configFileReportedCellularPasswordEnabled":{"nullable":false,"type":"boolean"},"configReportedOn":{"nullable":true,"type":"string","format":"date-time"},"differentConfigs":{"nullable":false,"type":"boolean"},"differentWanConfigs":{"nullable":false,"type":"boolean"},"stewardConfigFileServer":{"maxLength":4294967295,"minLength":0,"nullable":true,"type":"string"},"stewardConfigFileReported":{"maxLength":4294967295,"minLength":0,"nullable":true,"type":"string"},"stewardConfigReportedOn":{"nullable":true,"type":"string","format":"date-time"},"differentStewardConfigs":{"nullable":false,"type":"boolean"},"routerLan":{"nullable":false,"type":"object","properties":{"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"ipAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"netMask":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"network":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"dhcpServerEnabled":{"nullable":false,"type":"boolean"},"dhcpServerRangeFrom":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"dhcpServerRangeTo":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"gatewayLessRouting":{"nullable":false,"type":"boolean"},"forwardLanWan":{"enum":["neither","public","private","both"],"nullable":false,"type":"string"},"forwardLanWan2":{"enum":["neither","public","private","both"],"nullable":false,"type":"string"},"wlanEnable":{"nullable":true,"type":"boolean"},"wlanSsid":{"maxLength":32,"minLength":0,"nullable":true,"type":"string"},"wlanKey":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"wlanChannel":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"bacnetBbmd":{"type":"array","items":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}},"udpBroadcastRelayPort":{"type":"array","items":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}}}},"routerVpn":{"nullable":false,"type":"object","properties":{"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"sourceNatEnabled":{"nullable":false,"type":"boolean"}}},"routerWan":{"nullable":false,"type":"object","properties":{"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"multiwanPolicy":{"enum":["eth_cell_wifi","cell_eth_wifi","eth_wifi_cell","wifi_eth_cell","cell_wifi_eth","wifi_cell_eth"],"nullable":true,"type":"string"},"ipUseDhcp":{"nullable":true,"type":"boolean"},"ipAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"ipGateway":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"ipNetMask":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"dnsServers":{"type":"array","items":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}},"dnsRebindProtectionEnabled":{"nullable":true,"type":"boolean"},"cellularApn":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"cellularPincode":{"maxLength":8,"minLength":0,"nullable":true,"type":"string"},"cellularMtu":{"maximum":1500,"minimum":576,"nullable":true,"type":"integer","format":"int32"},"digitalInputMode":{"enum":["disable_vpn_high","disable_vpn_low","disable_wan_high","disable_wan_low"],"nullable":true,"type":"string"},"wanTrackInterval":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"wanTrackIps":{"type":"array","items":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}},"wlanTrackInterval":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"wlanTrackIps":{"type":"array","items":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}},"cellularTrackInterval":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"cellularTrackIps":{"type":"array","items":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}},"httpProxyAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"httpProxyPort":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"httpProxyAuthentication":{"enum":["none","basic","ntlm"],"nullable":true,"type":"string"},"httpProxyUsername":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"httpProxyIsSocks5":{"nullable":true,"type":"boolean"},"wlanSsid":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"wlanIpUseDhcp":{"nullable":true,"type":"boolean"},"wlanIpAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"wlanIpGateway":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"wlanIpNetMask":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"wlanDnsServers":{"type":"array","items":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}},"cellularUsername":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"}}},"routerDisplay":{"nullable":false,"type":"object","properties":{"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"lockEnabled":{"nullable":false,"type":"boolean"},"lockCode":{"maxLength":4,"minLength":4,"nullable":true,"pattern":"[0-9]+","type":"string"}}},"routerAdditionalSubnets":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"networkAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"networkMask":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"gatewayAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}},"routerPortForwards":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"interface":{"enum":["VPN","WAN","WAN2"],"nullable":false,"type":"string"},"targetIpAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"targetPort":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"externalPort":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}},"routerNtpServers":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"server":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}}},"macAddress":{"maxLength":17,"minLength":1,"nullable":false,"type":"string"},"serialNumber":{"maxLength":128,"minLength":1,"nullable":false,"type":"string"},"company":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":24,"minLength":24,"nullable":false,"pattern":"(\\d{4}-){4}\\d{4}","type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"activeStatus":{"enum":["active","inactive"],"nullable":false,"type":"string"},"activeVpnSession":{"nullable":true,"type":"object","properties":{"rscServer":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"vpnRange":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"supportedLayers":{"type":"array","items":{"enum":["tun","tap"],"nullable":false,"type":"string"}},"location":{"nullable":false,"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"latitude":{"nullable":false,"type":"string"},"longitude":{"nullable":false,"type":"string"}}}}},"startedOn":{"nullable":false,"type":"string","format":"date-time"},"sessionName":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"vpnAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"closed":{"nullable":false,"type":"boolean"}}},"vpnChangedOn":{"nullable":true,"type":"string","format":"date-time"},"mqttChangedOn":{"nullable":true,"type":"string","format":"date-time"},"mdrServer":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"lastSeenAgentUserAgent":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"value":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"configName":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"configVersion":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"hardware":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"hardwareCode":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"hardwareVersion":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"firmwareVersion":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"osName":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"osVersion":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"appName":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"appVersion":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"packageName":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"packageVersion":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"libixagentVersion":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"libixloggerVersion":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"logOnTrigger":{"nullable":false,"type":"boolean"},"alarming":{"nullable":false,"type":"boolean"},"dataMonitoring":{"nullable":false,"type":"boolean"},"wifi":{"nullable":false,"type":"boolean"},"remoteFirmwareUpgrade":{"nullable":false,"type":"boolean"},"staticMapping":{"nullable":false,"type":"boolean"},"stewardConfigPush":{"nullable":false,"type":"boolean"},"wanInterfaceEth0":{"nullable":false,"type":"boolean"},"wanInterfaceWifi0":{"nullable":false,"type":"boolean"},"wanInterfaceCell0":{"enum":["3G","4G","neither"],"nullable":false,"type":"string"},"multiWan":{"nullable":false,"type":"boolean"},"openvpnVersion":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"openvpnOccEnabled":{"nullable":false,"type":"boolean"},"openvpnOpensslVersion":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"}}},"vpnLocked":{"nullable":false,"type":"boolean"},"webAccessLocked":{"nullable":false,"type":"boolean"}}},"memberships":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"controlledDevice":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"group":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"}],"security":[{"bearerToken":[]}]},"patch":{"tags":["ControlledDeviceList"],"summary":"ControlledDeviceList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"vpnLocked":{"nullable":false,"type":"boolean"},"webAccessLocked":{"nullable":false,"type":"boolean"}}}}}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"post":{"tags":["ControlledDeviceList"],"summary":"ControlledDeviceList","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"device":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"controlKey":{"maxLength":11,"minLength":11,"nullable":false,"pattern":"[B-DF-HJ-NP-TV-Z]{3}-[1-9]{3}-[B-DF-HJ-NP-TV-Z]{3}","type":"string"},"groups":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}},"required":["name","device","controlKey"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"delete":{"tags":["ControlledDeviceList"],"summary":"ControlledDeviceList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/controlled-devices/memberships/{publicId}":{"get":{"tags":["ControlledDeviceMembership"],"summary":"ControlledDeviceMembership","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"controlledDevice":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"group":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"delete":{"tags":["ControlledDeviceMembership"],"summary":"ControlledDeviceMembership","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/controlled-devices/memberships":{"get":{"tags":["ControlledDeviceMembershipList"],"summary":"ControlledDeviceMembershipList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"controlledDevice":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"group":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"}],"security":[{"bearerToken":[]}]},"post":{"tags":["ControlledDeviceMembershipList"],"summary":"ControlledDeviceMembershipList","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"controlledDevice":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"group":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}},"required":["controlledDevice","group"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"delete":{"tags":["ControlledDeviceMembershipList"],"summary":"ControlledDeviceMembershipList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/custom-properties/{publicId}":{"get":{"tags":["CustomProperty"],"summary":"CustomProperty","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"scopeType":{"enum":["glb","app","sct","usr","com"],"nullable":false,"type":"string"},"resourceType":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"resourceVariant":{"maxLength":12,"minLength":12,"nullable":true,"type":"string"},"slug":{"maxLength":61,"minLength":1,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"required":{"nullable":false,"type":"boolean"},"validation":{"oneOf":[{"type":"object","properties":{"type":{"enum":["bool"],"nullable":false,"type":"string"}},"required":["type"]},{"type":"object","properties":{"type":{"enum":["datetime"],"nullable":false,"type":"string"}},"required":["type"]},{"type":"object","properties":{"type":{"enum":["emailaddress"],"nullable":false,"type":"string"}},"required":["type"]},{"type":"object","properties":{"type":{"enum":["enum"],"nullable":false,"type":"string"},"options":{"type":"array","items":{"maxLength":255,"minLength":1,"nullable":false,"pattern":"[^,]+","type":"string"}}},"required":["type"]},{"type":"object","properties":{"type":{"enum":["int"],"nullable":false,"type":"string"},"minValue":{"maximum":9223372036854776000,"minimum":-9223372036854776000,"nullable":true,"type":"integer","format":"int32"},"maxValue":{"maximum":9223372036854776000,"minimum":-9223372036854776000,"nullable":true,"type":"integer","format":"int32"}},"required":["type"]},{"type":"object","properties":{"type":{"enum":["locale"],"nullable":false,"type":"string"}},"required":["type"]},{"type":"object","properties":{"type":{"enum":["str"],"nullable":false,"type":"string"},"minLength":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"maxLength":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"regex":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"}},"required":["type"]},{"type":"object","properties":{"type":{"enum":["timezone"],"nullable":false,"type":"string"}},"required":["type"]},{"type":"object","properties":{"type":{"enum":["url"],"nullable":false,"type":"string"}},"required":["type"]}]},"flags":{"type":"array","items":{"maxLength":255,"minLength":1,"nullable":false,"pattern":"[^,]+","type":"string"}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/custom-properties":{"get":{"tags":["CustomPropertyList"],"summary":"CustomPropertyList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"scopeType":{"enum":["glb","app","sct","usr","com"],"nullable":false,"type":"string"},"resourceType":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"resourceVariant":{"maxLength":12,"minLength":12,"nullable":true,"type":"string"},"slug":{"maxLength":61,"minLength":1,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"required":{"nullable":false,"type":"boolean"},"validation":{"oneOf":[{"type":"object","properties":{"type":{"enum":["bool"],"nullable":false,"type":"string"}},"required":["type"]},{"type":"object","properties":{"type":{"enum":["datetime"],"nullable":false,"type":"string"}},"required":["type"]},{"type":"object","properties":{"type":{"enum":["emailaddress"],"nullable":false,"type":"string"}},"required":["type"]},{"type":"object","properties":{"type":{"enum":["enum"],"nullable":false,"type":"string"},"options":{"type":"array","items":{"maxLength":255,"minLength":1,"nullable":false,"pattern":"[^,]+","type":"string"}}},"required":["type"]},{"type":"object","properties":{"type":{"enum":["int"],"nullable":false,"type":"string"},"minValue":{"maximum":9223372036854776000,"minimum":-9223372036854776000,"nullable":true,"type":"integer","format":"int32"},"maxValue":{"maximum":9223372036854776000,"minimum":-9223372036854776000,"nullable":true,"type":"integer","format":"int32"}},"required":["type"]},{"type":"object","properties":{"type":{"enum":["locale"],"nullable":false,"type":"string"}},"required":["type"]},{"type":"object","properties":{"type":{"enum":["str"],"nullable":false,"type":"string"},"minLength":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"maxLength":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"regex":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"}},"required":["type"]},{"type":"object","properties":{"type":{"enum":["timezone"],"nullable":false,"type":"string"}},"required":["type"]},{"type":"object","properties":{"type":{"enum":["url"],"nullable":false,"type":"string"}},"required":["type"]}]},"flags":{"type":"array","items":{"maxLength":255,"minLength":1,"nullable":false,"pattern":"[^,]+","type":"string"}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"}],"security":[{"bearerToken":[]}]}},"/data-deletion-requests":{"post":{"tags":["DataDeletionRequestList"],"summary":"DataDeletionRequestList","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"source":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"start":{"nullable":false,"type":"string","format":"date-time"},"end":{"nullable":false,"type":"string","format":"date-time"}},"required":["source","start","end"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/data-export":{"post":{"tags":["DataExport"],"summary":"DataExport","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"start":{"nullable":false,"type":"string","format":"date-time"},"end":{"nullable":false,"type":"string","format":"date-time"},"timeZone":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"source":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"tags":{"type":"array","items":{"nullable":false,"type":"object","properties":{"id":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"slug":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"^[a-zA-Z0-9_\\[\\]-]+$","type":"string"},"queries":{"type":"array","items":{"nullable":false,"type":"object","properties":{"ref":{"maxLength":255,"minLength":1,"nullable":false,"pattern":"^[^{}]*$","type":"string"},"postAggr":{"enum":["count","mean","median","mode","spread","sum","first","last","max","min","raw"],"nullable":false,"type":"string"},"postTransform":{"enum":["difference"],"nullable":false,"type":"string"},"limit":{"maximum":5000,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"step":{"nullable":false},"offset":{"maximum":9223372036854776000,"nullable":false,"type":"integer","format":"int32"},"factor":{"nullable":false,"type":"string"},"operator":{"enum":["*","/","+","-"],"nullable":false,"type":"string"},"decimals":{"maximum":7,"nullable":false,"type":"integer","format":"int32"},"extendedBoundary":{"nullable":false,"type":"boolean"},"order":{"enum":["asc","desc"],"nullable":false,"type":"string"}}}}}}}},"required":["source","tags"]}}}},"security":[{"bearerToken":[]}]}},"/data":{"post":{"tags":["DataList"],"summary":"DataList","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"start":{"nullable":false,"type":"string","format":"date-time"},"end":{"nullable":false,"type":"string","format":"date-time"},"timeZone":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"source":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"points":{"type":"array","items":{"nullable":false,"type":"object","properties":{"time":{"maxLength":32,"minLength":1,"nullable":false,"type":"string"},"values":{"nullable":false,"type":"object"}}}}},"required":["start","end","timeZone","source","points"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"start":{"nullable":false,"type":"string","format":"date-time"},"end":{"nullable":false,"type":"string","format":"date-time"},"timeZone":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"source":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"tags":{"type":"array","items":{"nullable":false,"type":"object","properties":{"id":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"slug":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"^[a-zA-Z0-9_\\[\\]-]+$","type":"string"},"queries":{"type":"array","items":{"nullable":false,"type":"object","properties":{"ref":{"maxLength":255,"minLength":1,"nullable":false,"pattern":"^[^{}]*$","type":"string"},"postAggr":{"enum":["count","mean","median","mode","spread","sum","first","last","max","min","raw"],"nullable":false,"type":"string"},"postTransform":{"enum":["difference"],"nullable":false,"type":"string"},"limit":{"maximum":5000,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"step":{"nullable":false},"offset":{"maximum":9223372036854776000,"nullable":false,"type":"integer","format":"int32"},"factor":{"nullable":false,"type":"string"},"operator":{"enum":["*","/","+","-"],"nullable":false,"type":"string"},"decimals":{"maximum":7,"nullable":false,"type":"integer","format":"int32"},"extendedBoundary":{"nullable":false,"type":"boolean"},"order":{"enum":["asc","desc"],"nullable":false,"type":"string"}}}}}}}},"required":["source","tags"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/demo-devices":{"post":{"tags":["DemoDeviceList"],"summary":"DemoDeviceList","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"type":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}},"required":["type"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/":{"get":{"tags":["Discovery"],"summary":"Discovery","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"rel":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"href":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"methods":{"type":"array","items":{"enum":["DELETE","GET","PATCH","POST","PUT"],"nullable":false,"type":"string"}}},"required":["rel","href","methods"]}}}}}}}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiBrandingOptional"}]}},"/edge-apps":{"get":{"tags":["EdgeAppList"],"summary":"EdgeAppList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"company":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":24,"minLength":24,"nullable":false,"pattern":"(\\d{4}-){4}\\d{4}","type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"}],"security":[{"bearerToken":[]}]},"post":{"tags":["EdgeAppList"],"summary":"EdgeAppList","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"}},"required":["name"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"patch":{"tags":["EdgeAppList"],"summary":"EdgeAppList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/edge-app-versions":{"get":{"tags":["EdgeAppVersionList"],"summary":"EdgeAppVersionList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"edgeApp":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"number":{"maxLength":64,"minLength":1,"nullable":false,"type":"string"},"publishedOn":{"nullable":true,"type":"string","format":"date-time"},"createdOn":{"nullable":false,"type":"string","format":"date-time"},"createdBy":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"files":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"path":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"edgeAppVersion":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"agentEdgeAppInstance":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}},"services":{"type":"array","items":{"nullable":false,"type":"object","properties":{"name":{"maxLength":63,"minLength":1,"nullable":false,"type":"string"},"environment":{"nullable":false,"type":"object"}}}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"}],"security":[{"bearerToken":[]}]}},"/edge-apps/{publicId}/version-upload":{"post":{"tags":["EdgeAppVersionUpload"],"summary":"EdgeAppVersionUpload","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/zip":{"schema":{"type":"string","format":"binary"}}},"description":"This endpoint requires a zip file upload"},"security":[{"bearerToken":[]}]}},"/feedback":{"post":{"tags":["Feedback"],"summary":"Feedback","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingRequired"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"feedback":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"subject":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}},"required":["feedback","subject"]}}}},"security":[{"bearerToken":[]}]}},"/groups/{publicId}":{"get":{"tags":["Group"],"summary":"Group","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"type":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"order":{"maximum":9223372036854776000,"minimum":-9223372036854776000,"nullable":false,"type":"integer","format":"int32"},"color":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"custom":{"nullable":false,"type":"object"}}},"custom":{"nullable":false,"type":"object"},"agent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"asset":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"parent":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"type":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"order":{"maximum":9223372036854776000,"minimum":-9223372036854776000,"nullable":false,"type":"integer","format":"int32"},"color":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"custom":{"nullable":false,"type":"object"}}}}},"managedBy":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"type":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"order":{"maximum":9223372036854776000,"minimum":-9223372036854776000,"nullable":false,"type":"integer","format":"int32"},"color":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"custom":{"nullable":false,"type":"object"}}}}},"isCompanyGroup":{"nullable":false,"type":"boolean"}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"patch":{"tags":["Group"],"summary":"Group","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"type":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"parent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"custom":{"nullable":false,"type":"object"}}}}}},"security":[{"bearerToken":[]}]},"delete":{"tags":["Group"],"summary":"Group","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/groups":{"get":{"tags":["GroupList"],"summary":"GroupList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"type":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"order":{"maximum":9223372036854776000,"minimum":-9223372036854776000,"nullable":false,"type":"integer","format":"int32"},"color":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"custom":{"nullable":false,"type":"object"}}},"custom":{"nullable":false,"type":"object"},"agent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"asset":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"parent":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"type":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"order":{"maximum":9223372036854776000,"minimum":-9223372036854776000,"nullable":false,"type":"integer","format":"int32"},"color":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"custom":{"nullable":false,"type":"object"}}}}},"managedBy":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"type":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"order":{"maximum":9223372036854776000,"minimum":-9223372036854776000,"nullable":false,"type":"integer","format":"int32"},"color":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"custom":{"nullable":false,"type":"object"}}}}},"isCompanyGroup":{"nullable":false,"type":"boolean"}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"}],"security":[{"bearerToken":[]}]},"patch":{"tags":["GroupList"],"summary":"GroupList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"type":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"parent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"custom":{"nullable":false,"type":"object"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"post":{"tags":["GroupList"],"summary":"GroupList","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"type":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"parent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"custom":{"nullable":false,"type":"object"}},"required":["name","type"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"delete":{"tags":["GroupList"],"summary":"GroupList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/groups/{publicId}/page-import":{"post":{"tags":["GroupPageImport"],"summary":"GroupPageImport","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"string","format":"binary"}}},"description":"This endpoint requires a JSON file upload"},"security":[{"bearerToken":[]}]}},"/groups/roles":{"get":{"tags":["GroupRoleList"],"summary":"GroupRoleList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"group":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"type":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"order":{"maximum":9223372036854776000,"minimum":-9223372036854776000,"nullable":false,"type":"integer","format":"int32"},"color":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"custom":{"nullable":false,"type":"object"}}},"custom":{"nullable":false,"type":"object"},"agent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"asset":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"parent":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"type":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"order":{"maximum":9223372036854776000,"minimum":-9223372036854776000,"nullable":false,"type":"integer","format":"int32"},"color":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"custom":{"nullable":false,"type":"object"}}}}},"managedBy":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"type":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"order":{"maximum":9223372036854776000,"minimum":-9223372036854776000,"nullable":false,"type":"integer","format":"int32"},"color":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"custom":{"nullable":false,"type":"object"}}}}},"isCompanyGroup":{"nullable":false,"type":"boolean"}}},"roles":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"enforce2fa":{"nullable":false,"type":"boolean"},"enforceSso":{"nullable":false,"type":"boolean"},"permissions":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"custom":{"nullable":false,"type":"object"}}}},"audiences":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"custom":{"nullable":false,"type":"object"},"default":{"nullable":false,"type":"boolean"},"type":{"enum":["alarm","page","service"],"nullable":true,"type":"string"}}}},"custom":{"nullable":false,"type":"object"}}}}}}}}}}}}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"}],"security":[{"bearerToken":[]}]}},"/group-types/{publicId}":{"get":{"tags":["GroupType"],"summary":"GroupType","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"order":{"maximum":9223372036854776000,"minimum":-9223372036854776000,"nullable":false,"type":"integer","format":"int32"},"color":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"custom":{"nullable":false,"type":"object"}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"patch":{"tags":["GroupType"],"summary":"GroupType","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"order":{"maximum":9223372036854776000,"minimum":-9223372036854776000,"nullable":false,"type":"integer","format":"int32"},"color":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"custom":{"nullable":false,"type":"object"}}}}}},"security":[{"bearerToken":[]}]},"delete":{"tags":["GroupType"],"summary":"GroupType","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/group-types":{"get":{"tags":["GroupTypeList"],"summary":"GroupTypeList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"order":{"maximum":9223372036854776000,"minimum":-9223372036854776000,"nullable":false,"type":"integer","format":"int32"},"color":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"custom":{"nullable":false,"type":"object"}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"}],"security":[{"bearerToken":[]}]},"patch":{"tags":["GroupTypeList"],"summary":"GroupTypeList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"order":{"maximum":9223372036854776000,"minimum":-9223372036854776000,"nullable":false,"type":"integer","format":"int32"},"color":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"custom":{"nullable":false,"type":"object"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"post":{"tags":["GroupTypeList"],"summary":"GroupTypeList","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"order":{"maximum":9223372036854776000,"minimum":-9223372036854776000,"nullable":false,"type":"integer","format":"int32"},"color":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"custom":{"nullable":false,"type":"object"}},"required":["name"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"delete":{"tags":["GroupTypeList"],"summary":"GroupTypeList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/historical-data-usage":{"get":{"tags":["HistoricalDataUsage"],"summary":"HistoricalDataUsage","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"storedBytes":{"nullable":false,"type":"integer","format":"int32"}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"security":[{"bearerToken":[]}]}},"/invites/{publicId}":{"get":{"tags":["Invite"],"summary":"Invite","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"emailAddress":{"maxLength":254,"minLength":6,"nullable":false,"pattern":"^(?=.{1,254}$)(?=.{1,64}@)[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+(?:\\.[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+)*@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$","type":"string"},"expiresOn":{"nullable":false,"type":"string","format":"date-time"},"memberships":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"user":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"invite":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"group":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"role":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"expiresOn":{"nullable":true,"type":"string","format":"date-time"}}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"delete":{"tags":["Invite"],"summary":"Invite","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/invites/{publicId}/finish":{"post":{"tags":["InviteFinish"],"summary":"InviteFinish","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"termsOfUsePolicy":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}}}},"security":[{"bearerToken":[]}]}},"/invites":{"get":{"tags":["InviteList"],"summary":"InviteList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"emailAddress":{"maxLength":254,"minLength":6,"nullable":false,"pattern":"^(?=.{1,254}$)(?=.{1,64}@)[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+(?:\\.[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+)*@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$","type":"string"},"expiresOn":{"nullable":false,"type":"string","format":"date-time"},"memberships":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"user":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"invite":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"group":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"role":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"expiresOn":{"nullable":true,"type":"string","format":"date-time"}}}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"}],"security":[{"bearerToken":[]}]},"post":{"tags":["InviteList"],"summary":"InviteList","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"invites":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}}}},"userMemberships":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}}}}},"required":["invites","userMemberships"]}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingRequired"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"emailAddress":{"maxLength":254,"minLength":6,"nullable":false,"pattern":"^(?=.{1,254}$)(?=.{1,64}@)[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+(?:\\.[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+)*@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$","type":"string"},"message":{"maxLength":1024,"minLength":1,"nullable":false,"type":"string"},"groupRoles":{"type":"array","items":{"nullable":false,"type":"object","properties":{"group":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"role":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"expiresOn":{"nullable":true,"type":"string","format":"date-time"}}}},"language":{"maxLength":2,"minLength":2,"nullable":false,"type":"string"}},"required":["emailAddress","groupRoles"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"delete":{"tags":["InviteList"],"summary":"InviteList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/invites/{publicId}/resend":{"post":{"tags":["InviteResend"],"summary":"InviteResend","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingRequired"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/invites/resend":{"post":{"tags":["InviteResendList"],"summary":"InviteResendList","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingRequired"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/labels":{"get":{"tags":["LabelList"],"summary":"LabelList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"color":{"maxLength":7,"minLength":6,"nullable":false,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"company":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"}],"security":[{"bearerToken":[]}]},"post":{"tags":["LabelList"],"summary":"LabelList","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"color":{"maxLength":7,"minLength":6,"nullable":false,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}},"required":["color","name"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"patch":{"tags":["LabelList"],"summary":"LabelList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"color":{"maxLength":7,"minLength":6,"nullable":false,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"delete":{"tags":["LabelList"],"summary":"LabelList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/licences/{publicId}":{"get":{"tags":["Licence"],"summary":"Licence","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"type":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"usageType":{"enum":["advanced-user-management","agent-registration-profile","agent-templates","alarming","api-integrations","app-engine-level-1","app-engine-level-2","app-engine-level-3","asset-management","card-view","connection-monitoring","controlled-devices","custom-branding","custom-domain","custom-fields","custom-legal","custom-legal-legacy","custom-sso","edge-app-management","ixagent","landing-page","live-data","logging","m2m-cloud-cluster","main-pages","mobile-app","mqtt-device","object-storage","premium-branding","rdp","remote-access","reporting","request-access","rtsp","scim","session-recording","sla","ssh","subgroups","temporary-access","vpn-access-rule","vpn-usage"],"nullable":false,"type":"string"},"companyLimit":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"scope":{"enum":["agent","company"],"nullable":false,"type":"string"}}},"serialNumber":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"expiresOn":{"nullable":true,"type":"string","format":"date-time"},"activated":{"nullable":false,"type":"boolean"},"trial":{"nullable":false,"type":"boolean"},"value":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"locked":{"nullable":true,"type":"boolean"},"maxRetentionPolicy":{"maxLength":255,"minLength":2,"nullable":true,"type":"string"},"agent":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"deviceId":{"maxLength":128,"minLength":1,"nullable":false,"type":"string"},"type":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"location":{"nullable":false,"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"latitude":{"nullable":false,"type":"string"},"longitude":{"nullable":false,"type":"string"}}},"geoLocation":{"nullable":false,"type":"object","properties":{"latitude":{"nullable":false,"type":"string"},"longitude":{"nullable":false,"type":"string"},"country":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"city":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"custom":{"nullable":false,"type":"object"}}},"hasAgent":{"nullable":false,"type":"boolean"},"agentType":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"additionalSubnets":{"nullable":false,"type":"boolean"},"allowDataPublishing":{"nullable":false,"type":"boolean"},"allowDemoDevice":{"nullable":false,"type":"boolean"},"allowTemplating":{"nullable":false,"type":"boolean"},"allowReboot":{"nullable":false,"type":"boolean"},"configPush":{"nullable":false,"type":"boolean"},"configFileFormat":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"customServers":{"nullable":false,"type":"boolean"},"deviceIdFormat":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"httpProxyPort":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"latestFirmwareFile":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"code":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"notes":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"agentType":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"type":{"enum":["firmware"],"nullable":false,"type":"string"},"latest":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"offlineConfiguration":{"nullable":false,"type":"boolean"},"openvpnConfigMultiUse":{"nullable":false,"type":"boolean"},"purchasePrice":{"nullable":false,"type":"object","properties":{"gratis":{"nullable":false,"type":"boolean"}}},"router":{"nullable":false,"type":"boolean"},"stunnelSupport":{"nullable":false,"type":"boolean"},"wanPortForwardings":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"},"hasSecondWanPort":{"nullable":false,"type":"boolean"}}},"bundle":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/licence-bundles/{publicId}/extend":{"post":{"tags":["LicenceBundleExtend"],"summary":"LicenceBundleExtend","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"couponCode":{"maxLength":15,"minLength":15,"nullable":false,"pattern":"([1-9]{3}|[B-DF-HJ-NP-TV-Z]{3})(-([1-9]{3}|[B-DF-HJ-NP-TV-Z]{3})){3}","type":"string"},"licenceBundle":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}}}},"security":[{"bearerToken":[]}]}},"/licence-bundles":{"get":{"tags":["LicenceBundleList"],"summary":"LicenceBundleList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"}],"security":[{"bearerToken":[]}]}},"/licences/{publicId}/extend":{"post":{"tags":["LicenceExtend"],"summary":"LicenceExtend","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"couponCode":{"maxLength":15,"minLength":15,"nullable":false,"pattern":"([1-9]{3}|[B-DF-HJ-NP-TV-Z]{3})(-([1-9]{3}|[B-DF-HJ-NP-TV-Z]{3})){3}","type":"string"},"licence":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}}}},"security":[{"bearerToken":[]}]}},"/licences":{"get":{"tags":["LicenceList"],"summary":"LicenceList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"type":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"usageType":{"enum":["advanced-user-management","agent-registration-profile","agent-templates","alarming","api-integrations","app-engine-level-1","app-engine-level-2","app-engine-level-3","asset-management","card-view","connection-monitoring","controlled-devices","custom-branding","custom-domain","custom-fields","custom-legal","custom-legal-legacy","custom-sso","edge-app-management","ixagent","landing-page","live-data","logging","m2m-cloud-cluster","main-pages","mobile-app","mqtt-device","object-storage","premium-branding","rdp","remote-access","reporting","request-access","rtsp","scim","session-recording","sla","ssh","subgroups","temporary-access","vpn-access-rule","vpn-usage"],"nullable":false,"type":"string"},"companyLimit":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"scope":{"enum":["agent","company"],"nullable":false,"type":"string"}}},"serialNumber":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"expiresOn":{"nullable":true,"type":"string","format":"date-time"},"activated":{"nullable":false,"type":"boolean"},"trial":{"nullable":false,"type":"boolean"},"value":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"locked":{"nullable":true,"type":"boolean"},"maxRetentionPolicy":{"maxLength":255,"minLength":2,"nullable":true,"type":"string"},"agent":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"deviceId":{"maxLength":128,"minLength":1,"nullable":false,"type":"string"},"type":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"location":{"nullable":false,"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"latitude":{"nullable":false,"type":"string"},"longitude":{"nullable":false,"type":"string"}}},"geoLocation":{"nullable":false,"type":"object","properties":{"latitude":{"nullable":false,"type":"string"},"longitude":{"nullable":false,"type":"string"},"country":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"city":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"custom":{"nullable":false,"type":"object"}}},"hasAgent":{"nullable":false,"type":"boolean"},"agentType":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"additionalSubnets":{"nullable":false,"type":"boolean"},"allowDataPublishing":{"nullable":false,"type":"boolean"},"allowDemoDevice":{"nullable":false,"type":"boolean"},"allowTemplating":{"nullable":false,"type":"boolean"},"allowReboot":{"nullable":false,"type":"boolean"},"configPush":{"nullable":false,"type":"boolean"},"configFileFormat":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"customServers":{"nullable":false,"type":"boolean"},"deviceIdFormat":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"httpProxyPort":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"latestFirmwareFile":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"code":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"notes":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"agentType":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"type":{"enum":["firmware"],"nullable":false,"type":"string"},"latest":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"offlineConfiguration":{"nullable":false,"type":"boolean"},"openvpnConfigMultiUse":{"nullable":false,"type":"boolean"},"purchasePrice":{"nullable":false,"type":"object","properties":{"gratis":{"nullable":false,"type":"boolean"}}},"router":{"nullable":false,"type":"boolean"},"stunnelSupport":{"nullable":false,"type":"boolean"},"wanPortForwardings":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"},"hasSecondWanPort":{"nullable":false,"type":"boolean"}}},"bundle":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"}],"security":[{"bearerToken":[]}]},"post":{"tags":["LicenceList"],"summary":"LicenceList","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"type":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"usageType":{"enum":["advanced-user-management","agent-registration-profile","agent-templates","alarming","api-integrations","app-engine-level-1","app-engine-level-2","app-engine-level-3","asset-management","card-view","connection-monitoring","controlled-devices","custom-branding","custom-domain","custom-fields","custom-legal","custom-legal-legacy","custom-sso","edge-app-management","ixagent","landing-page","live-data","logging","m2m-cloud-cluster","main-pages","mobile-app","mqtt-device","object-storage","premium-branding","rdp","remote-access","reporting","request-access","rtsp","scim","session-recording","sla","ssh","subgroups","temporary-access","vpn-access-rule","vpn-usage"],"nullable":false,"type":"string"},"companyLimit":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"scope":{"enum":["agent","company"],"nullable":false,"type":"string"}}},"serialNumber":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"expiresOn":{"nullable":true,"type":"string","format":"date-time"},"activated":{"nullable":false,"type":"boolean"},"trial":{"nullable":false,"type":"boolean"},"value":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"locked":{"nullable":true,"type":"boolean"},"maxRetentionPolicy":{"maxLength":255,"minLength":2,"nullable":true,"type":"string"},"agent":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"deviceId":{"maxLength":128,"minLength":1,"nullable":false,"type":"string"},"type":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"location":{"nullable":false,"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"latitude":{"nullable":false,"type":"string"},"longitude":{"nullable":false,"type":"string"}}},"geoLocation":{"nullable":false,"type":"object","properties":{"latitude":{"nullable":false,"type":"string"},"longitude":{"nullable":false,"type":"string"},"country":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"city":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"custom":{"nullable":false,"type":"object"}}},"hasAgent":{"nullable":false,"type":"boolean"},"agentType":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"additionalSubnets":{"nullable":false,"type":"boolean"},"allowDataPublishing":{"nullable":false,"type":"boolean"},"allowDemoDevice":{"nullable":false,"type":"boolean"},"allowTemplating":{"nullable":false,"type":"boolean"},"allowReboot":{"nullable":false,"type":"boolean"},"configPush":{"nullable":false,"type":"boolean"},"configFileFormat":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"customServers":{"nullable":false,"type":"boolean"},"deviceIdFormat":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"httpProxyPort":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"latestFirmwareFile":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"code":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"notes":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"agentType":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"type":{"enum":["firmware"],"nullable":false,"type":"string"},"latest":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"offlineConfiguration":{"nullable":false,"type":"boolean"},"openvpnConfigMultiUse":{"nullable":false,"type":"boolean"},"purchasePrice":{"nullable":false,"type":"object","properties":{"gratis":{"nullable":false,"type":"boolean"}}},"router":{"nullable":false,"type":"boolean"},"stunnelSupport":{"nullable":false,"type":"boolean"},"wanPortForwardings":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"},"hasSecondWanPort":{"nullable":false,"type":"boolean"}}},"bundle":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"couponCode":{"maxLength":15,"minLength":15,"nullable":false,"pattern":"([1-9]{3}|[B-DF-HJ-NP-TV-Z]{3})(-([1-9]{3}|[B-DF-HJ-NP-TV-Z]{3})){3}","type":"string"}},"required":["couponCode"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/licences/extend":{"post":{"tags":["LicenceListExtend"],"summary":"LicenceListExtend","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"couponCode":{"maxLength":15,"minLength":15,"nullable":false,"pattern":"([1-9]{3}|[B-DF-HJ-NP-TV-Z]{3})(-([1-9]{3}|[B-DF-HJ-NP-TV-Z]{3})){3}","type":"string"},"licence":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/licence-types/{publicId}":{"get":{"tags":["LicenceType"],"summary":"LicenceType","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"usageType":{"enum":["advanced-user-management","agent-registration-profile","agent-templates","alarming","api-integrations","app-engine-level-1","app-engine-level-2","app-engine-level-3","asset-management","card-view","connection-monitoring","controlled-devices","custom-branding","custom-domain","custom-fields","custom-legal","custom-legal-legacy","custom-sso","edge-app-management","ixagent","landing-page","live-data","logging","m2m-cloud-cluster","main-pages","mobile-app","mqtt-device","object-storage","premium-branding","rdp","remote-access","reporting","request-access","rtsp","scim","session-recording","sla","ssh","subgroups","temporary-access","vpn-access-rule","vpn-usage"],"nullable":false,"type":"string"},"companyLimit":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"scope":{"enum":["agent","company"],"nullable":false,"type":"string"}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/filtersParameter"},{"$ref":"#/components/parameters/fieldsParameter"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/licence-types":{"get":{"tags":["LicenceTypeList"],"summary":"LicenceTypeList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"usageType":{"enum":["advanced-user-management","agent-registration-profile","agent-templates","alarming","api-integrations","app-engine-level-1","app-engine-level-2","app-engine-level-3","asset-management","card-view","connection-monitoring","controlled-devices","custom-branding","custom-domain","custom-fields","custom-legal","custom-legal-legacy","custom-sso","edge-app-management","ixagent","landing-page","live-data","logging","m2m-cloud-cluster","main-pages","mobile-app","mqtt-device","object-storage","premium-branding","rdp","remote-access","reporting","request-access","rtsp","scim","session-recording","sla","ssh","subgroups","temporary-access","vpn-access-rule","vpn-usage"],"nullable":false,"type":"string"},"companyLimit":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"scope":{"enum":["agent","company"],"nullable":false,"type":"string"}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/filtersParameter"},{"$ref":"#/components/parameters/fieldsParameter"}],"security":[{"bearerToken":[]}]}},"/agents/groups":{"post":{"tags":["MachineGroupList"],"summary":"MachineGroupList","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"asset":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"parent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"managedBy":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/menu-items/{publicId}":{"get":{"tags":["MenuItem"],"summary":"MenuItem","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"page":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"applicationType":{"enum":["sheet","card","report"],"nullable":false,"type":"string"},"company":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"group":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"draft":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"page":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"title":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"components":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"pageVersion":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"template":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"boundVersion":{"nullable":true,"type":"object","properties":{"template":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"number":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"\\d+","type":"string"},"mainPath":{"maxLength":255,"minLength":4,"nullable":false,"type":"string"},"notes":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"publishedOn":{"nullable":true,"type":"string","format":"date-time"},"createdOn":{"nullable":false,"type":"string","format":"date-time"},"createdBy":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}},"dimensions":{"oneOf":[{"type":"object","properties":{"type":{"enum":["sheet"],"nullable":false,"type":"string"},"left":{"maximum":11,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":71,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":12,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":72,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"mobileHeight":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"mobileOrder":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"mobileLeft":{"maximum":11,"nullable":true,"type":"integer","format":"int32"},"mobileCols":{"maximum":12,"minimum":1,"nullable":true,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]},{"type":"object","properties":{"type":{"enum":["card"],"nullable":false,"type":"string"},"height":{"maximum":65535,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}},"required":["type","height","order"]},{"type":"object","properties":{"type":{"enum":["report"],"nullable":false,"type":"string"},"left":{"maximum":7,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":15,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":8,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":16,"minimum":1,"nullable":false,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]},{"type":"object","properties":{"type":{"enum":["report-portrait"],"nullable":false,"type":"string"},"left":{"maximum":5,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":15,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":6,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":16,"minimum":1,"nullable":false,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]},{"type":"object","properties":{"type":{"enum":["report-landscape"],"nullable":false,"type":"string"},"left":{"maximum":7,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":10,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":8,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":11,"minimum":1,"nullable":false,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]}]},"inputs":{"maxLength":16777215,"minLength":0,"nullable":false,"type":"string"},"pagePage":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"pageVersion":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}}}}}},"previewAgent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"previewAsset":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"periodSpec":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"periodSelectorEnabled":{"nullable":false,"type":"boolean"},"defaultRefreshRate":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"createdOn":{"nullable":false,"type":"string","format":"date-time"},"createdBy":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"updatedOn":{"nullable":true,"type":"string","format":"date-time"},"updatedBy":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"pagePages":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"pageVersion":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}}}},"custom":{"nullable":false,"type":"object"}}},"published":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"page":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"title":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"components":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"pageVersion":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"template":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"boundVersion":{"nullable":true,"type":"object","properties":{"template":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"number":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"\\d+","type":"string"},"mainPath":{"maxLength":255,"minLength":4,"nullable":false,"type":"string"},"notes":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"publishedOn":{"nullable":true,"type":"string","format":"date-time"},"createdOn":{"nullable":false,"type":"string","format":"date-time"},"createdBy":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}},"dimensions":{"oneOf":[{"type":"object","properties":{"type":{"enum":["sheet"],"nullable":false,"type":"string"},"left":{"maximum":11,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":71,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":12,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":72,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"mobileHeight":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"mobileOrder":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"mobileLeft":{"maximum":11,"nullable":true,"type":"integer","format":"int32"},"mobileCols":{"maximum":12,"minimum":1,"nullable":true,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]},{"type":"object","properties":{"type":{"enum":["card"],"nullable":false,"type":"string"},"height":{"maximum":65535,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}},"required":["type","height","order"]},{"type":"object","properties":{"type":{"enum":["report"],"nullable":false,"type":"string"},"left":{"maximum":7,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":15,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":8,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":16,"minimum":1,"nullable":false,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]},{"type":"object","properties":{"type":{"enum":["report-portrait"],"nullable":false,"type":"string"},"left":{"maximum":5,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":15,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":6,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":16,"minimum":1,"nullable":false,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]},{"type":"object","properties":{"type":{"enum":["report-landscape"],"nullable":false,"type":"string"},"left":{"maximum":7,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":10,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":8,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":11,"minimum":1,"nullable":false,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]}]},"inputs":{"maxLength":16777215,"minLength":0,"nullable":false,"type":"string"},"pagePage":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"pageVersion":{"nullable":false,"type":"object"},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}}}}}},"previewAgent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"previewAsset":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"periodSpec":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"periodSelectorEnabled":{"nullable":false,"type":"boolean"},"defaultRefreshRate":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"createdOn":{"nullable":false,"type":"string","format":"date-time"},"createdBy":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"updatedOn":{"nullable":true,"type":"string","format":"date-time"},"updatedBy":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"pagePages":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"pageVersion":{"nullable":false,"type":"object"},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}}}},"custom":{"nullable":false,"type":"object"}}},"default":{"nullable":false,"type":"boolean"},"static":{"nullable":false,"type":"boolean"},"orientation":{"enum":["portrait","landscape"],"nullable":true,"type":"string"},"labels":{"type":"array","items":{"nullable":false,"type":"object","properties":{"color":{"maxLength":7,"minLength":6,"nullable":false,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"company":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}},"custom":{"nullable":false,"type":"object"}}},"pageLinks":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"asset":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"menuItem":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"page":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"audience":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"custom":{"nullable":false,"type":"object"},"default":{"nullable":false,"type":"boolean"},"type":{"enum":["alarm","page","service"],"nullable":true,"type":"string"}}},"group":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"asset":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"menuItem":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"custom":{"nullable":false,"type":"object"}}}},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"pinned":{"nullable":false,"type":"boolean"},"audience":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"custom":{"nullable":false,"type":"object"},"default":{"nullable":false,"type":"boolean"},"type":{"enum":["alarm","page","service"],"nullable":true,"type":"string"}}},"custom":{"nullable":false,"type":"object"}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"patch":{"tags":["MenuItem"],"summary":"MenuItem","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"page":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"pageLinks":{"type":"array","items":{"nullable":false,"type":"object","properties":{"page":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"audience":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"custom":{"nullable":false,"type":"object"},"group":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"}}}},"name":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"pinned":{"nullable":false,"type":"boolean"},"audience":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"custom":{"nullable":false,"type":"object"}}}}}},"security":[{"bearerToken":[]}]},"delete":{"tags":["MenuItem"],"summary":"MenuItem","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/menu-items":{"get":{"tags":["MenuItemList"],"summary":"MenuItemList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"page":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"applicationType":{"enum":["sheet","card","report"],"nullable":false,"type":"string"},"company":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"group":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"draft":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"page":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"title":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"components":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"pageVersion":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"template":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"boundVersion":{"nullable":true,"type":"object","properties":{"template":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"number":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"\\d+","type":"string"},"mainPath":{"maxLength":255,"minLength":4,"nullable":false,"type":"string"},"notes":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"publishedOn":{"nullable":true,"type":"string","format":"date-time"},"createdOn":{"nullable":false,"type":"string","format":"date-time"},"createdBy":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}},"dimensions":{"oneOf":[{"type":"object","properties":{"type":{"enum":["sheet"],"nullable":false,"type":"string"},"left":{"maximum":11,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":71,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":12,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":72,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"mobileHeight":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"mobileOrder":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"mobileLeft":{"maximum":11,"nullable":true,"type":"integer","format":"int32"},"mobileCols":{"maximum":12,"minimum":1,"nullable":true,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]},{"type":"object","properties":{"type":{"enum":["card"],"nullable":false,"type":"string"},"height":{"maximum":65535,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}},"required":["type","height","order"]},{"type":"object","properties":{"type":{"enum":["report"],"nullable":false,"type":"string"},"left":{"maximum":7,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":15,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":8,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":16,"minimum":1,"nullable":false,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]},{"type":"object","properties":{"type":{"enum":["report-portrait"],"nullable":false,"type":"string"},"left":{"maximum":5,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":15,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":6,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":16,"minimum":1,"nullable":false,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]},{"type":"object","properties":{"type":{"enum":["report-landscape"],"nullable":false,"type":"string"},"left":{"maximum":7,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":10,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":8,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":11,"minimum":1,"nullable":false,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]}]},"inputs":{"maxLength":16777215,"minLength":0,"nullable":false,"type":"string"},"pagePage":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"pageVersion":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}}}}}},"previewAgent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"previewAsset":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"periodSpec":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"periodSelectorEnabled":{"nullable":false,"type":"boolean"},"defaultRefreshRate":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"createdOn":{"nullable":false,"type":"string","format":"date-time"},"createdBy":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"updatedOn":{"nullable":true,"type":"string","format":"date-time"},"updatedBy":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"pagePages":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"pageVersion":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}}}},"custom":{"nullable":false,"type":"object"}}},"published":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"page":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"title":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"components":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"pageVersion":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"template":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"boundVersion":{"nullable":true,"type":"object","properties":{"template":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"number":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"\\d+","type":"string"},"mainPath":{"maxLength":255,"minLength":4,"nullable":false,"type":"string"},"notes":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"publishedOn":{"nullable":true,"type":"string","format":"date-time"},"createdOn":{"nullable":false,"type":"string","format":"date-time"},"createdBy":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}},"dimensions":{"oneOf":[{"type":"object","properties":{"type":{"enum":["sheet"],"nullable":false,"type":"string"},"left":{"maximum":11,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":71,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":12,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":72,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"mobileHeight":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"mobileOrder":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"mobileLeft":{"maximum":11,"nullable":true,"type":"integer","format":"int32"},"mobileCols":{"maximum":12,"minimum":1,"nullable":true,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]},{"type":"object","properties":{"type":{"enum":["card"],"nullable":false,"type":"string"},"height":{"maximum":65535,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}},"required":["type","height","order"]},{"type":"object","properties":{"type":{"enum":["report"],"nullable":false,"type":"string"},"left":{"maximum":7,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":15,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":8,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":16,"minimum":1,"nullable":false,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]},{"type":"object","properties":{"type":{"enum":["report-portrait"],"nullable":false,"type":"string"},"left":{"maximum":5,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":15,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":6,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":16,"minimum":1,"nullable":false,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]},{"type":"object","properties":{"type":{"enum":["report-landscape"],"nullable":false,"type":"string"},"left":{"maximum":7,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":10,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":8,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":11,"minimum":1,"nullable":false,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]}]},"inputs":{"maxLength":16777215,"minLength":0,"nullable":false,"type":"string"},"pagePage":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"pageVersion":{"nullable":false,"type":"object"},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}}}}}},"previewAgent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"previewAsset":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"periodSpec":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"periodSelectorEnabled":{"nullable":false,"type":"boolean"},"defaultRefreshRate":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"createdOn":{"nullable":false,"type":"string","format":"date-time"},"createdBy":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"updatedOn":{"nullable":true,"type":"string","format":"date-time"},"updatedBy":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"pagePages":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"pageVersion":{"nullable":false,"type":"object"},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}}}},"custom":{"nullable":false,"type":"object"}}},"default":{"nullable":false,"type":"boolean"},"static":{"nullable":false,"type":"boolean"},"orientation":{"enum":["portrait","landscape"],"nullable":true,"type":"string"},"labels":{"type":"array","items":{"nullable":false,"type":"object","properties":{"color":{"maxLength":7,"minLength":6,"nullable":false,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"company":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}},"custom":{"nullable":false,"type":"object"}}},"pageLinks":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"asset":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"menuItem":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"page":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"audience":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"custom":{"nullable":false,"type":"object"},"default":{"nullable":false,"type":"boolean"},"type":{"enum":["alarm","page","service"],"nullable":true,"type":"string"}}},"group":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"asset":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"menuItem":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"custom":{"nullable":false,"type":"object"}}}},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"pinned":{"nullable":false,"type":"boolean"},"audience":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"custom":{"nullable":false,"type":"object"},"default":{"nullable":false,"type":"boolean"},"type":{"enum":["alarm","page","service"],"nullable":true,"type":"string"}}},"custom":{"nullable":false,"type":"object"}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"}],"security":[{"bearerToken":[]}]},"patch":{"tags":["MenuItemList"],"summary":"MenuItemList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"page":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"pageLinks":{"type":"array","items":{"nullable":false,"type":"object","properties":{"page":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"audience":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"custom":{"nullable":false,"type":"object"},"group":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"}}}},"name":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"pinned":{"nullable":false,"type":"boolean"},"audience":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"custom":{"nullable":false,"type":"object"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"post":{"tags":["MenuItemList"],"summary":"MenuItemList","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"page":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"pageLinks":{"type":"array","items":{"nullable":false,"type":"object","properties":{"page":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"audience":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"custom":{"nullable":false,"type":"object"},"group":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"}}}},"name":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"pinned":{"nullable":false,"type":"boolean"},"audience":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"custom":{"nullable":false,"type":"object"}},"required":["order"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"delete":{"tags":["MenuItemList"],"summary":"MenuItemList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/messages/{publicId}":{"get":{"tags":["Message"],"summary":"Message","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":24,"minLength":24,"nullable":false,"type":"string"},"read":{"nullable":false,"type":"boolean"},"systemLabel":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"systemResult":{"type":"array","items":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}},"createdOn":{"nullable":false,"type":"string","format":"date-time"},"shortContent":{"nullable":false,"type":"object","properties":{"toTranslate":{"nullable":false,"type":"boolean"},"code":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"alarmName":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"agentName":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"name":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"occurredOn":{"nullable":false,"type":"string","format":"date-time"},"companyName":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"}}},"longContent":{"nullable":false,"type":"object","properties":{"toTranslate":{"nullable":false,"type":"boolean"},"code":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"extraInformation":{"type":"array","items":{"nullable":false,"type":"object","properties":{"type":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"toTranslate":{"nullable":false,"type":"boolean"},"key":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"value":{"nullable":false}}}},"instructions":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"patch":{"tags":["Message"],"summary":"Message","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"read":{"nullable":false,"type":"boolean"}},"required":["read"]}}}},"security":[{"bearerToken":[]}]},"delete":{"tags":["Message"],"summary":"Message","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/messages/all":{"patch":{"tags":["MessageAll"],"summary":"MessageAll","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"read":{"nullable":false,"type":"boolean"}},"required":["read"]}}}},"security":[{"bearerToken":[]}]}},"/message-filters/{publicId}":{"get":{"tags":["MessageFilter"],"summary":"MessageFilter","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"actions":{"type":"array","items":{"enum":["delete","mark-as-read","dont-send-webhook-trigger","forward-to-mail","dont-forward-to-mail","dont-send-push-notification"],"nullable":false,"type":"string"}},"companyPublicIds":{"type":"array","items":{"maxLength":24,"minLength":24,"nullable":false,"pattern":"(\\d{4}-){4}\\d{4}","type":"string"}},"notCompanyPublicIds":{"nullable":false,"type":"boolean"},"systemLabels":{"type":"array","items":{"enum":["router-pulled","alarm-low","alarm-medium","alarm-high"],"nullable":false,"type":"string"}},"notSystemLabels":{"nullable":false,"type":"boolean"},"longContains":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"notLongContains":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"shortContains":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"notShortContains":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"contains":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"notContains":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"patch":{"tags":["MessageFilter"],"summary":"MessageFilter","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"actions":{"type":"array","items":{"enum":["delete","mark-as-read","dont-send-webhook-trigger","forward-to-mail","dont-forward-to-mail","dont-send-push-notification"],"nullable":false,"type":"string"}},"companyPublicIds":{"type":"array","items":{"maxLength":24,"minLength":24,"nullable":false,"pattern":"(\\d{4}-){4}\\d{4}","type":"string"}},"notCompanyPublicIds":{"nullable":false,"type":"boolean"},"systemLabels":{"type":"array","items":{"enum":["router-pulled","alarm-low","alarm-medium","alarm-high"],"nullable":false,"type":"string"}},"notSystemLabels":{"nullable":false,"type":"boolean"},"longContains":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"notLongContains":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"shortContains":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"notShortContains":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"contains":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"notContains":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"}}}}}},"security":[{"bearerToken":[]}]},"delete":{"tags":["MessageFilter"],"summary":"MessageFilter","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/message-filters":{"get":{"tags":["MessageFilterList"],"summary":"MessageFilterList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"actions":{"type":"array","items":{"enum":["delete","mark-as-read","dont-send-webhook-trigger","forward-to-mail","dont-forward-to-mail","dont-send-push-notification"],"nullable":false,"type":"string"}},"companyPublicIds":{"type":"array","items":{"maxLength":24,"minLength":24,"nullable":false,"pattern":"(\\d{4}-){4}\\d{4}","type":"string"}},"notCompanyPublicIds":{"nullable":false,"type":"boolean"},"systemLabels":{"type":"array","items":{"enum":["router-pulled","alarm-low","alarm-medium","alarm-high"],"nullable":false,"type":"string"}},"notSystemLabels":{"nullable":false,"type":"boolean"},"longContains":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"notLongContains":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"shortContains":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"notShortContains":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"contains":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"notContains":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"}],"security":[{"bearerToken":[]}]},"post":{"tags":["MessageFilterList"],"summary":"MessageFilterList","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"actions":{"type":"array","items":{"enum":["delete","mark-as-read","dont-send-webhook-trigger","forward-to-mail","dont-forward-to-mail","dont-send-push-notification"],"nullable":false,"type":"string"}},"companyPublicIds":{"type":"array","items":{"maxLength":24,"minLength":24,"nullable":false,"pattern":"(\\d{4}-){4}\\d{4}","type":"string"}},"notCompanyPublicIds":{"nullable":false,"type":"boolean"},"systemLabels":{"type":"array","items":{"enum":["router-pulled","alarm-low","alarm-medium","alarm-high"],"nullable":false,"type":"string"}},"notSystemLabels":{"nullable":false,"type":"boolean"},"longContains":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"notLongContains":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"shortContains":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"notShortContains":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"contains":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"notContains":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"}},"required":["actions"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"patch":{"tags":["MessageFilterList"],"summary":"MessageFilterList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"actions":{"type":"array","items":{"enum":["delete","mark-as-read","dont-send-webhook-trigger","forward-to-mail","dont-forward-to-mail","dont-send-push-notification"],"nullable":false,"type":"string"}},"companyPublicIds":{"type":"array","items":{"maxLength":24,"minLength":24,"nullable":false,"pattern":"(\\d{4}-){4}\\d{4}","type":"string"}},"notCompanyPublicIds":{"nullable":false,"type":"boolean"},"systemLabels":{"type":"array","items":{"enum":["router-pulled","alarm-low","alarm-medium","alarm-high"],"nullable":false,"type":"string"}},"notSystemLabels":{"nullable":false,"type":"boolean"},"longContains":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"notLongContains":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"shortContains":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"notShortContains":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"contains":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"notContains":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"delete":{"tags":["MessageFilterList"],"summary":"MessageFilterList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/messages":{"get":{"tags":["MessageList"],"summary":"MessageList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":24,"minLength":24,"nullable":false,"type":"string"},"read":{"nullable":false,"type":"boolean"},"systemLabel":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"systemResult":{"type":"array","items":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}},"createdOn":{"nullable":false,"type":"string","format":"date-time"},"shortContent":{"nullable":false,"type":"object","properties":{"toTranslate":{"nullable":false,"type":"boolean"},"code":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"alarmName":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"agentName":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"name":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"occurredOn":{"nullable":false,"type":"string","format":"date-time"},"companyName":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"}}},"longContent":{"nullable":false,"type":"object","properties":{"toTranslate":{"nullable":false,"type":"boolean"},"code":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"extraInformation":{"type":"array","items":{"nullable":false,"type":"object","properties":{"type":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"toTranslate":{"nullable":false,"type":"boolean"},"key":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"value":{"nullable":false}}}},"instructions":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"}}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"security":[{"bearerToken":[]}]},"patch":{"tags":["MessageList"],"summary":"MessageList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":24,"minLength":24,"nullable":false,"type":"string"},"read":{"nullable":false,"type":"boolean"}},"required":["publicId","read"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"delete":{"tags":["MessageList"],"summary":"MessageList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":24,"minLength":24,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/mqtt-brokers/{publicId}":{"get":{"tags":["MqttBroker"],"summary":"MqttBroker","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"company":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"host":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"port":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"certauth":{"maxLength":65535,"minLength":0,"nullable":true,"pattern":"-----BEGIN CERTIFICATE-----(\\r\\n|\\r|\\n)(.|(\\r\\n|\\r|\\n))*(\\r\\n|\\r|\\n)-----END CERTIFICATE-----","type":"string"},"clients":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"company":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"mqttBroker":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"username":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"password":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"clientCert":{"maxLength":65535,"minLength":0,"nullable":true,"pattern":"-----BEGIN CERTIFICATE-----(\\r\\n|\\r|\\n)(.|(\\r\\n|\\r|\\n))*(\\r\\n|\\r|\\n)-----END CERTIFICATE-----","type":"string"}}}},"messageFormat":{"enum":["sparkplug_b","sparkplug_b_json"],"nullable":false,"type":"string"}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"patch":{"tags":["MqttBroker"],"summary":"MqttBroker","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"host":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"port":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"certauth":{"maxLength":65535,"minLength":0,"nullable":true,"pattern":"-----BEGIN CERTIFICATE-----(\\r\\n|\\r|\\n)(.|(\\r\\n|\\r|\\n))*(\\r\\n|\\r|\\n)-----END CERTIFICATE-----","type":"string"},"messageFormat":{"enum":["sparkplug_b","sparkplug_b_json"],"nullable":false,"type":"string"}}}}}},"security":[{"bearerToken":[]}]},"delete":{"tags":["MqttBroker"],"summary":"MqttBroker","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/mqtt-brokers/{brokerId}/clients/{publicId}":{"patch":{"tags":["MqttBrokerClient"],"summary":"MqttBrokerClient","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"brokerId","in":"path","schema":{"type":"string"}},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"username":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"password":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"clientCert":{"maxLength":65535,"minLength":0,"nullable":true,"pattern":"-----BEGIN CERTIFICATE-----(\\r\\n|\\r|\\n)(.|(\\r\\n|\\r|\\n))*(\\r\\n|\\r|\\n)-----END CERTIFICATE-----","type":"string"},"clientKey":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"}}}}}},"security":[{"bearerToken":[]}]},"delete":{"tags":["MqttBrokerClient"],"summary":"MqttBrokerClient","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"brokerId","in":"path","schema":{"type":"string"}},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/mqtt-brokers/{brokerId}/clients":{"post":{"tags":["MqttBrokerClientList"],"summary":"MqttBrokerClientList","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"brokerId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"username":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"password":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"clientCert":{"maxLength":65535,"minLength":0,"nullable":true,"pattern":"-----BEGIN CERTIFICATE-----(\\r\\n|\\r|\\n)(.|(\\r\\n|\\r|\\n))*(\\r\\n|\\r|\\n)-----END CERTIFICATE-----","type":"string"},"clientKey":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"}},"required":["name"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"patch":{"tags":["MqttBrokerClientList"],"summary":"MqttBrokerClientList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"brokerId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"username":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"password":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"clientCert":{"maxLength":65535,"minLength":0,"nullable":true,"pattern":"-----BEGIN CERTIFICATE-----(\\r\\n|\\r|\\n)(.|(\\r\\n|\\r|\\n))*(\\r\\n|\\r|\\n)-----END CERTIFICATE-----","type":"string"},"clientKey":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"delete":{"tags":["MqttBrokerClientList"],"summary":"MqttBrokerClientList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"brokerId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/mqtt-brokers/{brokerId}/clients/{publicId}/message":{"post":{"tags":["MqttBrokerClientMessage"],"summary":"MqttBrokerClientMessage","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"brokerId","in":"path","schema":{"type":"string"}},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"clientId":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"topic":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"message":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"}},"required":["publicId","topic"]}}}},"security":[{"bearerToken":[]}]}},"/mqtt-brokers":{"get":{"tags":["MqttBrokerList"],"summary":"MqttBrokerList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"company":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"host":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"port":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"certauth":{"maxLength":65535,"minLength":0,"nullable":true,"pattern":"-----BEGIN CERTIFICATE-----(\\r\\n|\\r|\\n)(.|(\\r\\n|\\r|\\n))*(\\r\\n|\\r|\\n)-----END CERTIFICATE-----","type":"string"},"clients":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"company":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"mqttBroker":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"username":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"password":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"clientCert":{"maxLength":65535,"minLength":0,"nullable":true,"pattern":"-----BEGIN CERTIFICATE-----(\\r\\n|\\r|\\n)(.|(\\r\\n|\\r|\\n))*(\\r\\n|\\r|\\n)-----END CERTIFICATE-----","type":"string"}}}},"messageFormat":{"enum":["sparkplug_b","sparkplug_b_json"],"nullable":false,"type":"string"}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"}],"security":[{"bearerToken":[]}]},"post":{"tags":["MqttBrokerList"],"summary":"MqttBrokerList","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"host":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"port":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"certauth":{"maxLength":65535,"minLength":0,"nullable":true,"pattern":"-----BEGIN CERTIFICATE-----(\\r\\n|\\r|\\n)(.|(\\r\\n|\\r|\\n))*(\\r\\n|\\r|\\n)-----END CERTIFICATE-----","type":"string"},"messageFormat":{"enum":["sparkplug_b","sparkplug_b_json"],"nullable":false,"type":"string"}},"required":["name","host","port","messageFormat"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"patch":{"tags":["MqttBrokerList"],"summary":"MqttBrokerList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"host":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"port":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"certauth":{"maxLength":65535,"minLength":0,"nullable":true,"pattern":"-----BEGIN CERTIFICATE-----(\\r\\n|\\r|\\n)(.|(\\r\\n|\\r|\\n))*(\\r\\n|\\r|\\n)-----END CERTIFICATE-----","type":"string"},"messageFormat":{"enum":["sparkplug_b","sparkplug_b_json"],"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"delete":{"tags":["MqttBrokerList"],"summary":"MqttBrokerList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/access-recover/me":{"get":{"tags":["MyAccessRecover"],"summary":"MyAccessRecover","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"emailAddress":{"maxLength":254,"minLength":6,"nullable":false,"pattern":"^(?=.{1,254}$)(?=.{1,64}@)[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+(?:\\.[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+)*@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$","type":"string"}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"}]},"delete":{"tags":["MyAccessRecover"],"summary":"MyAccessRecover","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"}]}},"/access-recover/me/finish":{"post":{"tags":["MyAccessRecoverFinish"],"summary":"MyAccessRecoverFinish","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingRequired"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"newPassword":{"minLength":8,"nullable":false,"type":"string"},"deleteAccessTokens":{"nullable":false,"type":"boolean"}},"required":["newPassword","deleteAccessTokens"]}}}}}},"/access-tokens/me":{"get":{"tags":["MyAccessToken"],"summary":"MyAccessToken","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"expiresOn":{"nullable":false,"type":"string","format":"date-time"},"geoLocation":{"nullable":false,"type":"object","properties":{"latitude":{"nullable":false,"type":"string"},"longitude":{"nullable":false,"type":"string"},"country":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"city":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"created":{"nullable":false,"type":"object","properties":{"ip":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"on":{"nullable":false,"type":"string","format":"date-time"},"userAgent":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"}}},"scope":{"oneOf":[{"type":"object","properties":{"type":{"enum":["unrestricted"],"nullable":false,"type":"string"}},"required":["type"]},{"type":"object","properties":{"type":{"enum":["allow"],"nullable":false,"type":"string"},"rels":{"type":"array","items":{"nullable":false,"type":"object","properties":{"rel":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"get":{"nullable":true,"type":"boolean"},"post":{"nullable":true,"type":"boolean"},"patch":{"nullable":true,"type":"boolean"},"delete":{"nullable":true,"type":"boolean"},"put":{"nullable":true,"type":"boolean"}}}}},"required":["type","rels"]},{"type":"object","properties":{"type":{"enum":["deny"],"nullable":false,"type":"string"},"rels":{"type":"array","items":{"nullable":false,"type":"object","properties":{"rel":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"get":{"nullable":true,"type":"boolean"},"post":{"nullable":true,"type":"boolean"},"patch":{"nullable":true,"type":"boolean"},"delete":{"nullable":true,"type":"boolean"},"put":{"nullable":true,"type":"boolean"}}}}},"required":["type","rels"]}]},"ssoIdentityProvider":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"companies":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"logo":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"}],"security":[{"bearerToken":[]}]},"delete":{"tags":["MyAccessToken"],"summary":"MyAccessToken","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"security":[{"bearerToken":[]}]}},"/companies/me":{"get":{"tags":["MyCompany"],"summary":"MyCompany","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":24,"minLength":24,"nullable":false,"pattern":"(\\d{4}-){4}\\d{4}","type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"country":{"maxLength":2,"minLength":2,"nullable":false,"type":"string"},"defaultUserInviteLanguage":{"maxLength":2,"minLength":2,"nullable":false,"type":"string"},"supportAccessExpiresOn":{"nullable":true,"type":"string","format":"date-time"},"appOwnerName":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"custom":{"nullable":false,"type":"object"},"branding":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"fqdn":{"maxLength":253,"minLength":4,"nullable":true,"pattern":".+(\\..[^.]+)","type":"string"},"theme":{"nullable":true,"type":"object","properties":{"primaryColor":{"maxLength":7,"minLength":6,"nullable":false,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"primaryTextColor":{"maxLength":7,"minLength":6,"nullable":false,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"accentColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"accentTextColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"headerColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"headerLineColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"menuColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"menuTextColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"pageColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"pageTextColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"cardColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"cardTextColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"logoHasBackgroundColor":{"nullable":false,"type":"boolean"},"logoOnHeaderColorSpec":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"}}},"appleTouchIcon":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"favicon":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"logo":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"logoDark":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"appleAppStoreLink":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"googlePlayStoreLink":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"landingPageComponentTemplate":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"company":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"version":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"author":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"licence":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"url":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"sheetSettings":{"nullable":true,"type":"object","properties":{"minCols":{"maximum":11,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"defaultCols":{"maximum":11,"minimum":1,"nullable":true,"type":"integer","format":"int32"},"maxCols":{"maximum":11,"minimum":1,"nullable":true,"type":"integer","format":"int32"},"minRows":{"maximum":11,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"defaultRows":{"maximum":11,"minimum":1,"nullable":true,"type":"integer","format":"int32"},"maxRows":{"maximum":11,"minimum":1,"nullable":true,"type":"integer","format":"int32"}}},"cardSettings":{"nullable":true,"type":"object","properties":{"minHeight":{"maximum":65535,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"defaultHeight":{"maximum":65535,"minimum":1,"nullable":true,"type":"integer","format":"int32"},"maxHeight":{"maximum":65535,"minimum":1,"nullable":true,"type":"integer","format":"int32"}}},"inputs":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"draft":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"published":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"category":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}}},"configuredVersion":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"number":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"\\d+","type":"string"},"mainPath":{"maxLength":255,"minLength":4,"nullable":false,"type":"string"}}},"backendComponent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"static":{"nullable":false,"type":"boolean"},"intent":{"type":"array","items":{"enum":["asset-configuration","landing-page","main-page"],"nullable":false,"type":"string"}},"private":{"nullable":false,"type":"boolean"}}},"custom":{"nullable":false,"type":"object"}}},"screensaver":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"requireDedicatedRscServer":{"nullable":false,"type":"boolean"},"requireDedicatedMdrServer":{"nullable":false,"type":"boolean"},"loggingTrialUsed":{"nullable":false,"type":"boolean"},"alarmingTrialUsed":{"nullable":false,"type":"boolean"},"premiumLicence":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"type":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"usageType":{"enum":["advanced-user-management","agent-registration-profile","agent-templates","alarming","api-integrations","app-engine-level-1","app-engine-level-2","app-engine-level-3","asset-management","card-view","connection-monitoring","controlled-devices","custom-branding","custom-domain","custom-fields","custom-legal","custom-legal-legacy","custom-sso","edge-app-management","ixagent","landing-page","live-data","logging","m2m-cloud-cluster","main-pages","mobile-app","mqtt-device","object-storage","premium-branding","rdp","remote-access","reporting","request-access","rtsp","scim","session-recording","sla","ssh","subgroups","temporary-access","vpn-access-rule","vpn-usage"],"nullable":false,"type":"string"},"companyLimit":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"scope":{"enum":["agent","company"],"nullable":false,"type":"string"}}},"serialNumber":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"expiresOn":{"nullable":true,"type":"string","format":"date-time"},"activated":{"nullable":false,"type":"boolean"},"trial":{"nullable":false,"type":"boolean"},"value":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"locked":{"nullable":true,"type":"boolean"},"maxRetentionPolicy":{"maxLength":255,"minLength":2,"nullable":true,"type":"string"},"bundle":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}},"premiumLicenceStatus":{"enum":["not-configured","pending","activated"],"nullable":true,"type":"string"},"reportingLicence":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"type":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"usageType":{"enum":["advanced-user-management","agent-registration-profile","agent-templates","alarming","api-integrations","app-engine-level-1","app-engine-level-2","app-engine-level-3","asset-management","card-view","connection-monitoring","controlled-devices","custom-branding","custom-domain","custom-fields","custom-legal","custom-legal-legacy","custom-sso","edge-app-management","ixagent","landing-page","live-data","logging","m2m-cloud-cluster","main-pages","mobile-app","mqtt-device","object-storage","premium-branding","rdp","remote-access","reporting","request-access","rtsp","scim","session-recording","sla","ssh","subgroups","temporary-access","vpn-access-rule","vpn-usage"],"nullable":false,"type":"string"},"companyLimit":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"scope":{"enum":["agent","company"],"nullable":false,"type":"string"}}},"serialNumber":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"expiresOn":{"nullable":true,"type":"string","format":"date-time"},"activated":{"nullable":false,"type":"boolean"},"trial":{"nullable":false,"type":"boolean"},"value":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"locked":{"nullable":true,"type":"boolean"},"maxRetentionPolicy":{"maxLength":255,"minLength":2,"nullable":true,"type":"string"},"bundle":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}},"slaLicence":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"type":{"nullable":false,"type":"object"},"serialNumber":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"expiresOn":{"nullable":true,"type":"string","format":"date-time"},"activated":{"nullable":false,"type":"boolean"},"trial":{"nullable":false,"type":"boolean"},"value":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"locked":{"nullable":true,"type":"boolean"},"maxRetentionPolicy":{"maxLength":255,"minLength":2,"nullable":true,"type":"string"},"bundle":{"nullable":true,"type":"object"}}},"vpnUsageLicence":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"type":{"nullable":false,"type":"object"},"serialNumber":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"expiresOn":{"nullable":true,"type":"string","format":"date-time"},"activated":{"nullable":false,"type":"boolean"},"trial":{"nullable":false,"type":"boolean"},"value":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"locked":{"nullable":true,"type":"boolean"},"maxRetentionPolicy":{"maxLength":255,"minLength":2,"nullable":true,"type":"string"},"bundle":{"nullable":true,"type":"object"}}},"vpnAccessRuleLicence":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"type":{"nullable":false,"type":"object"},"serialNumber":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"expiresOn":{"nullable":true,"type":"string","format":"date-time"},"activated":{"nullable":false,"type":"boolean"},"trial":{"nullable":false,"type":"boolean"},"value":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"locked":{"nullable":true,"type":"boolean"},"maxRetentionPolicy":{"maxLength":255,"minLength":2,"nullable":true,"type":"string"},"bundle":{"nullable":true,"type":"object"}}},"assetManagementLicence":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"type":{"nullable":false,"type":"object"},"serialNumber":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"expiresOn":{"nullable":true,"type":"string","format":"date-time"},"activated":{"nullable":false,"type":"boolean"},"trial":{"nullable":false,"type":"boolean"},"value":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"locked":{"nullable":true,"type":"boolean"},"maxRetentionPolicy":{"maxLength":255,"minLength":2,"nullable":true,"type":"string"},"bundle":{"nullable":true,"type":"object"}}},"mobileAppLicence":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"type":{"nullable":false,"type":"object"},"serialNumber":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"expiresOn":{"nullable":true,"type":"string","format":"date-time"},"activated":{"nullable":false,"type":"boolean"},"trial":{"nullable":false,"type":"boolean"},"value":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"locked":{"nullable":true,"type":"boolean"},"maxRetentionPolicy":{"maxLength":255,"minLength":2,"nullable":true,"type":"string"},"bundle":{"nullable":true,"type":"object"}}},"mobileAppLicenceStatus":{"enum":["not-configured","pending","activated"],"nullable":true,"type":"string"},"licenceModel":{"enum":["legacy","modules"],"nullable":false,"type":"string"},"customTermsOfUse":{"enum":["sector","company","disabled"],"nullable":false,"type":"string"},"customPrivacyStatement":{"enum":["sector","company","disabled"],"nullable":false,"type":"string"},"latestTermsOfUse":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"company":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"latest":{"nullable":true,"type":"boolean"},"version":{"maxLength":5,"minLength":1,"nullable":true,"type":"string"},"publishedOn":{"nullable":true,"type":"string","format":"date-time"},"downloadUrl":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"type":{"enum":["termsofuse","privacystatement"],"nullable":false,"type":"string"},"languages":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"languageCode":{"maxLength":2,"minLength":2,"nullable":false,"type":"string"},"body":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"updateSummary":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"policy":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}}}},"latestPrivacyStatement":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"company":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"latest":{"nullable":true,"type":"boolean"},"version":{"maxLength":5,"minLength":1,"nullable":true,"type":"string"},"publishedOn":{"nullable":true,"type":"string","format":"date-time"},"downloadUrl":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"type":{"enum":["termsofuse","privacystatement"],"nullable":false,"type":"string"},"languages":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"languageCode":{"maxLength":2,"minLength":2,"nullable":false,"type":"string"},"body":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"updateSummary":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"policy":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}}}},"shellAgentLimit":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"createdOn":{"nullable":true,"type":"string","format":"date-time"}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"}],"security":[{"bearerToken":[]}]},"patch":{"tags":["MyCompany"],"summary":"MyCompany","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"country":{"maxLength":2,"minLength":2,"nullable":false,"type":"string"},"defaultUserInviteLanguage":{"maxLength":2,"minLength":2,"nullable":false,"type":"string"},"appOwnerName":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"branding":{"nullable":true,"type":"object","properties":{"name":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"theme":{"nullable":true,"type":"object","properties":{"primaryColor":{"maxLength":7,"minLength":6,"nullable":false,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"primaryTextColor":{"maxLength":7,"minLength":6,"nullable":false,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"accentColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"accentTextColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"headerColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"headerLineColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"menuColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"menuTextColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"pageColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"pageTextColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"cardColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"cardTextColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"logoHasBackgroundColor":{"nullable":false,"type":"boolean"},"logoOnHeaderColorSpec":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"}}},"appleTouchIcon":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"favicon":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"logo":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"logoDark":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"landingPageComponentTemplate":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"custom":{"nullable":false,"type":"object"}}},"customTermsOfUse":{"enum":["sector","company","disabled"],"nullable":false,"type":"string"},"customPrivacyStatement":{"enum":["sector","company","disabled"],"nullable":false,"type":"string"},"custom":{"nullable":false,"type":"object"}}}}}},"security":[{"bearerToken":[]}]}},"/companies/me/custom-properties/{publicId}":{"patch":{"tags":["MyCompanyCustomProperty"],"summary":"MyCompanyCustomProperty","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"required":{"nullable":false,"type":"boolean"},"validation":{"oneOf":[{"type":"object","properties":{"type":{"enum":["bool"],"nullable":false,"type":"string"}},"required":["type"]},{"type":"object","properties":{"type":{"enum":["datetime"],"nullable":false,"type":"string"}},"required":["type"]},{"type":"object","properties":{"type":{"enum":["emailaddress"],"nullable":false,"type":"string"}},"required":["type"]},{"type":"object","properties":{"type":{"enum":["enum"],"nullable":false,"type":"string"},"options":{"type":"array","items":{"maxLength":255,"minLength":1,"nullable":false,"pattern":"[^,]+","type":"string"}}},"required":["type"]},{"type":"object","properties":{"type":{"enum":["int"],"nullable":false,"type":"string"},"minValue":{"maximum":9223372036854776000,"minimum":-9223372036854776000,"nullable":true,"type":"integer","format":"int32"},"maxValue":{"maximum":9223372036854776000,"minimum":-9223372036854776000,"nullable":true,"type":"integer","format":"int32"}},"required":["type"]},{"type":"object","properties":{"type":{"enum":["locale"],"nullable":false,"type":"string"}},"required":["type"]},{"type":"object","properties":{"type":{"enum":["str"],"nullable":false,"type":"string"},"minLength":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"maxLength":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"regex":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"}},"required":["type"]},{"type":"object","properties":{"type":{"enum":["timezone"],"nullable":false,"type":"string"}},"required":["type"]},{"type":"object","properties":{"type":{"enum":["url"],"nullable":false,"type":"string"}},"required":["type"]}]},"flags":{"type":"array","items":{"maxLength":255,"minLength":1,"nullable":false,"pattern":"[^,]+","type":"string"}}}}}}},"security":[{"bearerToken":[]}]},"delete":{"tags":["MyCompanyCustomProperty"],"summary":"MyCompanyCustomProperty","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/companies/me/custom-properties":{"post":{"tags":["MyCompanyCustomPropertyList"],"summary":"MyCompanyCustomPropertyList","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"resourceType":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"resourceVariant":{"maxLength":12,"minLength":12,"nullable":true,"type":"string"},"slug":{"maxLength":29,"minLength":1,"nullable":false,"pattern":"([A-Z][a-z0-9]*)+","type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"required":{"nullable":false,"type":"boolean"},"validation":{"oneOf":[{"type":"object","properties":{"type":{"enum":["bool"],"nullable":false,"type":"string"}},"required":["type"]},{"type":"object","properties":{"type":{"enum":["datetime"],"nullable":false,"type":"string"}},"required":["type"]},{"type":"object","properties":{"type":{"enum":["emailaddress"],"nullable":false,"type":"string"}},"required":["type"]},{"type":"object","properties":{"type":{"enum":["enum"],"nullable":false,"type":"string"},"options":{"type":"array","items":{"maxLength":255,"minLength":1,"nullable":false,"pattern":"[^,]+","type":"string"}}},"required":["type"]},{"type":"object","properties":{"type":{"enum":["int"],"nullable":false,"type":"string"},"minValue":{"maximum":9223372036854776000,"minimum":-9223372036854776000,"nullable":true,"type":"integer","format":"int32"},"maxValue":{"maximum":9223372036854776000,"minimum":-9223372036854776000,"nullable":true,"type":"integer","format":"int32"}},"required":["type"]},{"type":"object","properties":{"type":{"enum":["locale"],"nullable":false,"type":"string"}},"required":["type"]},{"type":"object","properties":{"type":{"enum":["str"],"nullable":false,"type":"string"},"minLength":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"maxLength":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"regex":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"}},"required":["type"]},{"type":"object","properties":{"type":{"enum":["timezone"],"nullable":false,"type":"string"}},"required":["type"]},{"type":"object","properties":{"type":{"enum":["url"],"nullable":false,"type":"string"}},"required":["type"]}]},"flags":{"type":"array","items":{"maxLength":255,"minLength":1,"nullable":false,"pattern":"[^,]+","type":"string"}}},"required":["resourceType","slug","name","validation"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"patch":{"tags":["MyCompanyCustomPropertyList"],"summary":"MyCompanyCustomPropertyList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"required":{"nullable":false,"type":"boolean"},"validation":{"oneOf":[{"type":"object","properties":{"type":{"enum":["bool"],"nullable":false,"type":"string"}},"required":["type"]},{"type":"object","properties":{"type":{"enum":["datetime"],"nullable":false,"type":"string"}},"required":["type"]},{"type":"object","properties":{"type":{"enum":["emailaddress"],"nullable":false,"type":"string"}},"required":["type"]},{"type":"object","properties":{"type":{"enum":["enum"],"nullable":false,"type":"string"},"options":{"type":"array","items":{"maxLength":255,"minLength":1,"nullable":false,"pattern":"[^,]+","type":"string"}}},"required":["type"]},{"type":"object","properties":{"type":{"enum":["int"],"nullable":false,"type":"string"},"minValue":{"maximum":9223372036854776000,"minimum":-9223372036854776000,"nullable":true,"type":"integer","format":"int32"},"maxValue":{"maximum":9223372036854776000,"minimum":-9223372036854776000,"nullable":true,"type":"integer","format":"int32"}},"required":["type"]},{"type":"object","properties":{"type":{"enum":["locale"],"nullable":false,"type":"string"}},"required":["type"]},{"type":"object","properties":{"type":{"enum":["str"],"nullable":false,"type":"string"},"minLength":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"maxLength":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"regex":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"}},"required":["type"]},{"type":"object","properties":{"type":{"enum":["timezone"],"nullable":false,"type":"string"}},"required":["type"]},{"type":"object","properties":{"type":{"enum":["url"],"nullable":false,"type":"string"}},"required":["type"]}]},"flags":{"type":"array","items":{"maxLength":255,"minLength":1,"nullable":false,"pattern":"[^,]+","type":"string"}}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"delete":{"tags":["MyCompanyCustomPropertyList"],"summary":"MyCompanyCustomPropertyList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/platform-servers/me":{"get":{"tags":["MyCompanyPlatformServerList"],"summary":"MyCompanyPlatformServerList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"type":{"maxLength":3,"minLength":3,"nullable":false,"type":"string"},"location":{"nullable":false,"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"latitude":{"nullable":false,"type":"string"},"longitude":{"nullable":false,"type":"string"}}},"vpnRange":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"}],"security":[{"bearerToken":[]}]}},"/companies/me/support-access":{"post":{"tags":["MyCompanySupportAccess"],"summary":"MyCompanySupportAccess","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"expiresOn":{"nullable":false,"type":"string","format":"date-time"},"caseNumber":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"message":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"}},"required":["expiresOn"]}}}},"security":[{"bearerToken":[]}]},"patch":{"tags":["MyCompanySupportAccess"],"summary":"MyCompanySupportAccess","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"expiresOn":{"nullable":false,"type":"string","format":"date-time"}},"required":["expiresOn"]}}}},"security":[{"bearerToken":[]}]},"delete":{"tags":["MyCompanySupportAccess"],"summary":"MyCompanySupportAccess","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"security":[{"bearerToken":[]}]}},"/email-address-changes/me":{"get":{"tags":["MyEmailAddressChange"],"summary":"MyEmailAddressChange","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"oldEmailAddress":{"maxLength":254,"minLength":6,"nullable":false,"pattern":"^(?=.{1,254}$)(?=.{1,64}@)[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+(?:\\.[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+)*@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$","type":"string"},"newEmailAddress":{"maxLength":254,"minLength":6,"nullable":false,"pattern":"^(?=.{1,254}$)(?=.{1,64}@)[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+(?:\\.[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+)*@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$","type":"string"},"expiresOn":{"nullable":false,"type":"string","format":"date-time"},"user":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"emailAddress":{"maxLength":254,"minLength":6,"nullable":false,"pattern":"^(?=.{1,254}$)(?=.{1,64}@)[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+(?:\\.[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+)*@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$","type":"string"},"custom":{"nullable":false,"type":"object"},"language":{"maxLength":2,"minLength":2,"nullable":false,"type":"string"},"localisation":{"maxLength":10,"minLength":1,"nullable":true,"type":"string"},"timeZone":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"}]},"delete":{"tags":["MyEmailAddressChange"],"summary":"MyEmailAddressChange","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"}]}},"/email-address-changes/me/finish":{"post":{"tags":["MyEmailAddressChangeFinish"],"summary":"MyEmailAddressChangeFinish","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"}]}},"/invites/me":{"get":{"tags":["MyInvite"],"summary":"MyInvite","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"emailAddress":{"maxLength":254,"minLength":6,"nullable":false,"pattern":"^(?=.{1,254}$)(?=.{1,64}@)[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+(?:\\.[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+)*@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$","type":"string"},"expiresOn":{"nullable":false,"type":"string","format":"date-time"},"language":{"maxLength":2,"minLength":2,"nullable":false,"type":"string"},"company":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":24,"minLength":24,"nullable":false,"pattern":"(\\d{4}-){4}\\d{4}","type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"custom":{"nullable":false,"type":"object"},"branding":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"fqdn":{"maxLength":253,"minLength":4,"nullable":true,"pattern":".+(\\..[^.]+)","type":"string"},"theme":{"nullable":true,"type":"object","properties":{"primaryColor":{"maxLength":7,"minLength":6,"nullable":false,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"primaryTextColor":{"maxLength":7,"minLength":6,"nullable":false,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"accentColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"accentTextColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"headerColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"headerLineColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"menuColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"menuTextColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"pageColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"pageTextColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"cardColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"cardTextColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"logoHasBackgroundColor":{"nullable":false,"type":"boolean"},"logoOnHeaderColorSpec":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"}}},"appleTouchIcon":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"favicon":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"logo":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"logoDark":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"appleAppStoreLink":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"googlePlayStoreLink":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"landingPageComponentTemplate":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"company":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"version":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"author":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"licence":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"url":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"sheetSettings":{"nullable":true,"type":"object","properties":{"minCols":{"maximum":11,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"defaultCols":{"maximum":11,"minimum":1,"nullable":true,"type":"integer","format":"int32"},"maxCols":{"maximum":11,"minimum":1,"nullable":true,"type":"integer","format":"int32"},"minRows":{"maximum":11,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"defaultRows":{"maximum":11,"minimum":1,"nullable":true,"type":"integer","format":"int32"},"maxRows":{"maximum":11,"minimum":1,"nullable":true,"type":"integer","format":"int32"}}},"cardSettings":{"nullable":true,"type":"object","properties":{"minHeight":{"maximum":65535,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"defaultHeight":{"maximum":65535,"minimum":1,"nullable":true,"type":"integer","format":"int32"},"maxHeight":{"maximum":65535,"minimum":1,"nullable":true,"type":"integer","format":"int32"}}},"inputs":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"draft":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"published":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"category":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}}},"configuredVersion":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"number":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"\\d+","type":"string"},"mainPath":{"maxLength":255,"minLength":4,"nullable":false,"type":"string"}}},"backendComponent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"static":{"nullable":false,"type":"boolean"},"intent":{"type":"array","items":{"enum":["asset-configuration","landing-page","main-page"],"nullable":false,"type":"string"}},"private":{"nullable":false,"type":"boolean"}}},"custom":{"nullable":false,"type":"object"}}},"customTermsOfUse":{"enum":["sector","company","disabled"],"nullable":false,"type":"string"},"customPrivacyStatement":{"enum":["sector","company","disabled"],"nullable":false,"type":"string"},"latestTermsOfUse":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"company":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"latest":{"nullable":true,"type":"boolean"},"version":{"maxLength":5,"minLength":1,"nullable":true,"type":"string"},"publishedOn":{"nullable":true,"type":"string","format":"date-time"},"downloadUrl":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"type":{"enum":["termsofuse","privacystatement"],"nullable":false,"type":"string"},"languages":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"languageCode":{"maxLength":2,"minLength":2,"nullable":false,"type":"string"},"body":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"updateSummary":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"policy":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}}}},"latestPrivacyStatement":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"company":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"latest":{"nullable":true,"type":"boolean"},"version":{"maxLength":5,"minLength":1,"nullable":true,"type":"string"},"publishedOn":{"nullable":true,"type":"string","format":"date-time"},"downloadUrl":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"type":{"enum":["termsofuse","privacystatement"],"nullable":false,"type":"string"},"languages":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"languageCode":{"maxLength":2,"minLength":2,"nullable":false,"type":"string"},"body":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"updateSummary":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"policy":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}}}}}},"user":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"emailAddress":{"maxLength":254,"minLength":6,"nullable":false,"pattern":"^(?=.{1,254}$)(?=.{1,64}@)[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+(?:\\.[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+)*@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$","type":"string"},"custom":{"nullable":false,"type":"object"},"language":{"maxLength":2,"minLength":2,"nullable":false,"type":"string"},"localisation":{"maxLength":10,"minLength":1,"nullable":true,"type":"string"},"timeZone":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"}}},"memberships":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"user":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"invite":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"group":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"role":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"expiresOn":{"nullable":true,"type":"string","format":"date-time"}}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"}]},"delete":{"tags":["MyInvite"],"summary":"MyInvite","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"}]}},"/invites/me/finish":{"post":{"tags":["MyInviteFinish"],"summary":"MyInviteFinish","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"termsOfUsePolicy":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}}}}}},"/otp-auth-disable/me":{"delete":{"tags":["MyOtpAuthDisable"],"summary":"MyOtpAuthDisable","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"}]},"get":{"tags":["MyOtpAuthDisable"],"summary":"MyOtpAuthDisable","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"emailAddress":{"maxLength":254,"minLength":6,"nullable":false,"pattern":"^(?=.{1,254}$)(?=.{1,64}@)[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+(?:\\.[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+)*@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$","type":"string"},"custom":{"nullable":false,"type":"object"},"language":{"maxLength":2,"minLength":2,"nullable":false,"type":"string"},"localisation":{"maxLength":10,"minLength":1,"nullable":true,"type":"string"},"timeZone":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"}]}},"/otp-auth-disable/me/finish":{"post":{"tags":["MyOtpAuthDisableFinish"],"summary":"MyOtpAuthDisableFinish","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"}]}},"/registrations/me":{"get":{"tags":["MyRegistration"],"summary":"MyRegistration","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":24,"minLength":24,"nullable":false,"pattern":"(\\d{4}-){4}\\d{4}","type":"string"},"companyName":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"emailAddress":{"maxLength":254,"minLength":6,"nullable":false,"pattern":"^(?=.{1,254}$)(?=.{1,64}@)[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+(?:\\.[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+)*@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$","type":"string"},"language":{"maxLength":2,"minLength":2,"nullable":true,"type":"string"}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"}]},"delete":{"tags":["MyRegistration"],"summary":"MyRegistration","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"}]}},"/registrations/me/finish":{"post":{"tags":["MyRegistrationFinish"],"summary":"MyRegistrationFinish","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"}]}},"/sectors/me":{"get":{"tags":["MySector"],"summary":"MySector","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"corporateWebsite":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"defaultCountry":{"maxLength":2,"minLength":2,"nullable":false,"type":"string"},"custom":{"nullable":false,"type":"object"},"emailFromAddress":{"maxLength":320,"minLength":1,"nullable":false,"type":"string"},"feedbackTo":{"maxLength":320,"minLength":1,"nullable":true,"type":"string"},"supportEmailAddress":{"maxLength":320,"minLength":1,"nullable":true,"type":"string"},"allowCustomTermsOfUse":{"nullable":false,"type":"boolean"},"allowCustomPrivacyStatement":{"nullable":false,"type":"boolean"},"latestTermsOfUse":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"company":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"latest":{"nullable":true,"type":"boolean"},"version":{"maxLength":5,"minLength":1,"nullable":true,"type":"string"},"publishedOn":{"nullable":true,"type":"string","format":"date-time"},"downloadUrl":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"type":{"enum":["termsofuse","privacystatement"],"nullable":false,"type":"string"},"languages":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"languageCode":{"maxLength":2,"minLength":2,"nullable":false,"type":"string"},"body":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"updateSummary":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"policy":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}}}},"latestPrivacyStatement":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"company":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"latest":{"nullable":true,"type":"boolean"},"version":{"maxLength":5,"minLength":1,"nullable":true,"type":"string"},"publishedOn":{"nullable":true,"type":"string","format":"date-time"},"downloadUrl":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"type":{"enum":["termsofuse","privacystatement"],"nullable":false,"type":"string"},"languages":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"languageCode":{"maxLength":2,"minLength":2,"nullable":false,"type":"string"},"body":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"updateSummary":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"policy":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}}}},"branding":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"fqdn":{"maxLength":253,"minLength":4,"nullable":true,"pattern":".+(\\..[^.]+)","type":"string"},"theme":{"nullable":true,"type":"object","properties":{"primaryColor":{"maxLength":7,"minLength":6,"nullable":false,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"primaryTextColor":{"maxLength":7,"minLength":6,"nullable":false,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"accentColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"accentTextColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"headerColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"headerLineColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"menuColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"menuTextColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"pageColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"pageTextColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"cardColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"cardTextColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"logoHasBackgroundColor":{"nullable":false,"type":"boolean"},"logoOnHeaderColorSpec":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"}}},"appleTouchIcon":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"favicon":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"logo":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"logoDark":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"appleAppStoreLink":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"googlePlayStoreLink":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"landingPageComponentTemplate":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"company":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"version":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"author":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"licence":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"url":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"sheetSettings":{"nullable":true,"type":"object","properties":{"minCols":{"maximum":11,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"defaultCols":{"maximum":11,"minimum":1,"nullable":true,"type":"integer","format":"int32"},"maxCols":{"maximum":11,"minimum":1,"nullable":true,"type":"integer","format":"int32"},"minRows":{"maximum":11,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"defaultRows":{"maximum":11,"minimum":1,"nullable":true,"type":"integer","format":"int32"},"maxRows":{"maximum":11,"minimum":1,"nullable":true,"type":"integer","format":"int32"}}},"cardSettings":{"nullable":true,"type":"object","properties":{"minHeight":{"maximum":65535,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"defaultHeight":{"maximum":65535,"minimum":1,"nullable":true,"type":"integer","format":"int32"},"maxHeight":{"maximum":65535,"minimum":1,"nullable":true,"type":"integer","format":"int32"}}},"inputs":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"draft":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"published":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"category":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}}},"configuredVersion":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"number":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"\\d+","type":"string"},"mainPath":{"maxLength":255,"minLength":4,"nullable":false,"type":"string"}}},"backendComponent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"static":{"nullable":false,"type":"boolean"},"intent":{"type":"array","items":{"enum":["asset-configuration","landing-page","main-page"],"nullable":false,"type":"string"}},"private":{"nullable":false,"type":"boolean"}}},"custom":{"nullable":false,"type":"object"}}},"premiumBrandingDomain":{"maxLength":253,"minLength":4,"nullable":true,"pattern":".+(\\..[^.]+)","type":"string"},"cdnDomain":{"maxLength":253,"minLength":4,"nullable":true,"pattern":".+(\\..[^.]+)","type":"string"},"poweredBy":{"nullable":true,"type":"object","properties":{"hide":{"nullable":false,"type":"boolean"},"logo":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"name":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"url":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"}]}},"/users/me":{"get":{"tags":["MyUser"],"summary":"MyUser","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"type":{"enum":["person","service_account"],"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"emailAddress":{"maxLength":254,"minLength":6,"nullable":true,"pattern":"^(?=.{1,254}$)(?=.{1,64}@)[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+(?:\\.[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+)*@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$","type":"string"},"support":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"},"hasPassword":{"nullable":false,"type":"boolean"},"externallyManaged":{"nullable":false,"type":"boolean"},"language":{"maxLength":2,"minLength":2,"nullable":false,"type":"string"},"localisation":{"maxLength":10,"minLength":1,"nullable":true,"type":"string"},"timeZone":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"registeredOn":{"nullable":false,"type":"string","format":"date-time"},"lastSeenOn":{"nullable":false,"type":"string","format":"date-time"},"registeredBy":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"emailAddressChanges":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"oldEmailAddress":{"maxLength":254,"minLength":6,"nullable":false,"pattern":"^(?=.{1,254}$)(?=.{1,64}@)[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+(?:\\.[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+)*@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$","type":"string"},"newEmailAddress":{"maxLength":254,"minLength":6,"nullable":false,"pattern":"^(?=.{1,254}$)(?=.{1,64}@)[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+(?:\\.[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+)*@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$","type":"string"},"expiresOn":{"nullable":false,"type":"string","format":"date-time"}}}},"invites":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"emailAddress":{"maxLength":254,"minLength":6,"nullable":false,"pattern":"^(?=.{1,254}$)(?=.{1,64}@)[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+(?:\\.[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+)*@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$","type":"string"},"expiresOn":{"nullable":false,"type":"string","format":"date-time"},"memberships":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"user":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"invite":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"group":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"role":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"expiresOn":{"nullable":true,"type":"string","format":"date-time"}}}}}}},"unreadMessagesCount":{"maximum":2147483647,"minimum":-2147483648,"nullable":false,"type":"integer","format":"int32"},"otpAuth":{"nullable":false,"type":"object","properties":{"required":{"nullable":false,"type":"boolean"},"deviceName":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"registeredOn":{"nullable":true,"type":"string","format":"date-time"},"tokenExpiresOn":{"nullable":true,"type":"string","format":"date-time"},"type":{"enum":["app","sms"],"nullable":true,"type":"string"}}},"apiApplications":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"custom":{"nullable":false,"type":"object"}}}},"phoneNumber":{"maxLength":16,"minLength":3,"nullable":true,"pattern":"\\+[0-9]{2,15}","type":"string"},"acceptedTermsOfUsePolicies":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"policy":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"company":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"latest":{"nullable":true,"type":"boolean"},"version":{"maxLength":5,"minLength":1,"nullable":true,"type":"string"},"publishedOn":{"nullable":true,"type":"string","format":"date-time"},"downloadUrl":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"type":{"enum":["termsofuse","privacystatement"],"nullable":false,"type":"string"},"languages":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"languageCode":{"maxLength":2,"minLength":2,"nullable":false,"type":"string"},"body":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"updateSummary":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"policy":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}}}},"company":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"acceptedOn":{"nullable":false,"type":"string","format":"date-time"}}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"}],"security":[{"bearerToken":[]}]},"patch":{"tags":["MyUser"],"summary":"MyUser","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"language":{"maxLength":2,"minLength":2,"nullable":false,"type":"string"},"localisation":{"maxLength":10,"minLength":1,"nullable":true,"type":"string"},"timeZone":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"custom":{"nullable":false,"type":"object"},"phoneNumber":{"maxLength":16,"minLength":3,"nullable":true,"pattern":"\\+[0-9]{2,15}","type":"string"}}}}}},"security":[{"bearerToken":[]}]},"delete":{"tags":["MyUser"],"summary":"MyUser","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"security":[{"bearerToken":[]}]}},"/users/me/email-address-changes/{publicId}":{"get":{"tags":["MyUserEmailAddressChange"],"summary":"MyUserEmailAddressChange","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"oldEmailAddress":{"maxLength":254,"minLength":6,"nullable":false,"pattern":"^(?=.{1,254}$)(?=.{1,64}@)[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+(?:\\.[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+)*@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$","type":"string"},"newEmailAddress":{"maxLength":254,"minLength":6,"nullable":false,"pattern":"^(?=.{1,254}$)(?=.{1,64}@)[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+(?:\\.[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+)*@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$","type":"string"},"expiresOn":{"nullable":false,"type":"string","format":"date-time"},"user":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"emailAddress":{"maxLength":254,"minLength":6,"nullable":false,"pattern":"^(?=.{1,254}$)(?=.{1,64}@)[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+(?:\\.[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+)*@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$","type":"string"},"custom":{"nullable":false,"type":"object"},"language":{"maxLength":2,"minLength":2,"nullable":false,"type":"string"},"localisation":{"maxLength":10,"minLength":1,"nullable":true,"type":"string"},"timeZone":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"delete":{"tags":["MyUserEmailAddressChange"],"summary":"MyUserEmailAddressChange","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/users/me/email-address-changes":{"get":{"tags":["MyUserEmailAddressChangeList"],"summary":"MyUserEmailAddressChangeList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"oldEmailAddress":{"maxLength":254,"minLength":6,"nullable":false,"pattern":"^(?=.{1,254}$)(?=.{1,64}@)[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+(?:\\.[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+)*@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$","type":"string"},"newEmailAddress":{"maxLength":254,"minLength":6,"nullable":false,"pattern":"^(?=.{1,254}$)(?=.{1,64}@)[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+(?:\\.[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+)*@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$","type":"string"},"expiresOn":{"nullable":false,"type":"string","format":"date-time"},"user":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"emailAddress":{"maxLength":254,"minLength":6,"nullable":false,"pattern":"^(?=.{1,254}$)(?=.{1,64}@)[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+(?:\\.[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+)*@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$","type":"string"},"custom":{"nullable":false,"type":"object"},"language":{"maxLength":2,"minLength":2,"nullable":false,"type":"string"},"localisation":{"maxLength":10,"minLength":1,"nullable":true,"type":"string"},"timeZone":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"}}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"}],"security":[{"bearerToken":[]}]},"post":{"tags":["MyUserEmailAddressChangeList"],"summary":"MyUserEmailAddressChangeList","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingRequired"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"newEmailAddress":{"maxLength":254,"minLength":6,"nullable":false,"pattern":"^(?=.{1,254}$)(?=.{1,64}@)[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+(?:\\.[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+)*@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$","type":"string"}},"required":["newEmailAddress"]}}}},"security":[{"bearerToken":[]}]},"delete":{"tags":["MyUserEmailAddressChangeList"],"summary":"MyUserEmailAddressChangeList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/users/me/invites/{publicId}":{"get":{"tags":["MyUserInvite"],"summary":"MyUserInvite","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"emailAddress":{"maxLength":254,"minLength":6,"nullable":false,"pattern":"^(?=.{1,254}$)(?=.{1,64}@)[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+(?:\\.[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+)*@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$","type":"string"},"expiresOn":{"nullable":false,"type":"string","format":"date-time"},"memberships":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"user":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"invite":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"group":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"role":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"expiresOn":{"nullable":true,"type":"string","format":"date-time"}}}},"company":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":24,"minLength":24,"nullable":false,"pattern":"(\\d{4}-){4}\\d{4}","type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"custom":{"nullable":false,"type":"object"},"branding":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"fqdn":{"maxLength":253,"minLength":4,"nullable":true,"pattern":".+(\\..[^.]+)","type":"string"},"theme":{"nullable":true,"type":"object","properties":{"primaryColor":{"maxLength":7,"minLength":6,"nullable":false,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"primaryTextColor":{"maxLength":7,"minLength":6,"nullable":false,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"accentColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"accentTextColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"headerColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"headerLineColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"menuColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"menuTextColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"pageColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"pageTextColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"cardColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"cardTextColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"logoHasBackgroundColor":{"nullable":false,"type":"boolean"},"logoOnHeaderColorSpec":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"}}},"appleTouchIcon":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"favicon":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"logo":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"logoDark":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"appleAppStoreLink":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"googlePlayStoreLink":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"landingPageComponentTemplate":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"company":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"version":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"author":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"licence":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"url":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"sheetSettings":{"nullable":true,"type":"object","properties":{"minCols":{"maximum":11,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"defaultCols":{"maximum":11,"minimum":1,"nullable":true,"type":"integer","format":"int32"},"maxCols":{"maximum":11,"minimum":1,"nullable":true,"type":"integer","format":"int32"},"minRows":{"maximum":11,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"defaultRows":{"maximum":11,"minimum":1,"nullable":true,"type":"integer","format":"int32"},"maxRows":{"maximum":11,"minimum":1,"nullable":true,"type":"integer","format":"int32"}}},"cardSettings":{"nullable":true,"type":"object","properties":{"minHeight":{"maximum":65535,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"defaultHeight":{"maximum":65535,"minimum":1,"nullable":true,"type":"integer","format":"int32"},"maxHeight":{"maximum":65535,"minimum":1,"nullable":true,"type":"integer","format":"int32"}}},"inputs":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"draft":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"published":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"category":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}}},"configuredVersion":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"number":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"\\d+","type":"string"},"mainPath":{"maxLength":255,"minLength":4,"nullable":false,"type":"string"}}},"backendComponent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"static":{"nullable":false,"type":"boolean"},"intent":{"type":"array","items":{"enum":["asset-configuration","landing-page","main-page"],"nullable":false,"type":"string"}},"private":{"nullable":false,"type":"boolean"}}},"custom":{"nullable":false,"type":"object"}}},"customTermsOfUse":{"enum":["sector","company","disabled"],"nullable":false,"type":"string"},"customPrivacyStatement":{"enum":["sector","company","disabled"],"nullable":false,"type":"string"},"latestTermsOfUse":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"company":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"latest":{"nullable":true,"type":"boolean"},"version":{"maxLength":5,"minLength":1,"nullable":true,"type":"string"},"publishedOn":{"nullable":true,"type":"string","format":"date-time"},"downloadUrl":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"type":{"enum":["termsofuse","privacystatement"],"nullable":false,"type":"string"},"languages":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"languageCode":{"maxLength":2,"minLength":2,"nullable":false,"type":"string"},"body":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"updateSummary":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"policy":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}}}},"latestPrivacyStatement":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"company":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"latest":{"nullable":true,"type":"boolean"},"version":{"maxLength":5,"minLength":1,"nullable":true,"type":"string"},"publishedOn":{"nullable":true,"type":"string","format":"date-time"},"downloadUrl":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"type":{"enum":["termsofuse","privacystatement"],"nullable":false,"type":"string"},"languages":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"languageCode":{"maxLength":2,"minLength":2,"nullable":false,"type":"string"},"body":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"updateSummary":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"policy":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}}}}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"delete":{"tags":["MyUserInvite"],"summary":"MyUserInvite","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/users/me/invites":{"get":{"tags":["MyUserInviteList"],"summary":"MyUserInviteList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"emailAddress":{"maxLength":254,"minLength":6,"nullable":false,"pattern":"^(?=.{1,254}$)(?=.{1,64}@)[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+(?:\\.[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+)*@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$","type":"string"},"expiresOn":{"nullable":false,"type":"string","format":"date-time"},"memberships":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"user":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"invite":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"group":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"role":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"expiresOn":{"nullable":true,"type":"string","format":"date-time"}}}},"company":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":24,"minLength":24,"nullable":false,"pattern":"(\\d{4}-){4}\\d{4}","type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"custom":{"nullable":false,"type":"object"},"branding":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"fqdn":{"maxLength":253,"minLength":4,"nullable":true,"pattern":".+(\\..[^.]+)","type":"string"},"theme":{"nullable":true,"type":"object","properties":{"primaryColor":{"maxLength":7,"minLength":6,"nullable":false,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"primaryTextColor":{"maxLength":7,"minLength":6,"nullable":false,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"accentColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"accentTextColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"headerColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"headerLineColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"menuColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"menuTextColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"pageColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"pageTextColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"cardColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"cardTextColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"logoHasBackgroundColor":{"nullable":false,"type":"boolean"},"logoOnHeaderColorSpec":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"}}},"appleTouchIcon":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"favicon":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"logo":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"logoDark":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"appleAppStoreLink":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"googlePlayStoreLink":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"landingPageComponentTemplate":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"company":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"version":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"author":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"licence":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"url":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"sheetSettings":{"nullable":true,"type":"object","properties":{"minCols":{"maximum":11,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"defaultCols":{"maximum":11,"minimum":1,"nullable":true,"type":"integer","format":"int32"},"maxCols":{"maximum":11,"minimum":1,"nullable":true,"type":"integer","format":"int32"},"minRows":{"maximum":11,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"defaultRows":{"maximum":11,"minimum":1,"nullable":true,"type":"integer","format":"int32"},"maxRows":{"maximum":11,"minimum":1,"nullable":true,"type":"integer","format":"int32"}}},"cardSettings":{"nullable":true,"type":"object","properties":{"minHeight":{"maximum":65535,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"defaultHeight":{"maximum":65535,"minimum":1,"nullable":true,"type":"integer","format":"int32"},"maxHeight":{"maximum":65535,"minimum":1,"nullable":true,"type":"integer","format":"int32"}}},"inputs":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"draft":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"published":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"category":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}}},"configuredVersion":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"number":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"\\d+","type":"string"},"mainPath":{"maxLength":255,"minLength":4,"nullable":false,"type":"string"}}},"backendComponent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"static":{"nullable":false,"type":"boolean"},"intent":{"type":"array","items":{"enum":["asset-configuration","landing-page","main-page"],"nullable":false,"type":"string"}},"private":{"nullable":false,"type":"boolean"}}},"custom":{"nullable":false,"type":"object"}}},"customTermsOfUse":{"enum":["sector","company","disabled"],"nullable":false,"type":"string"},"customPrivacyStatement":{"enum":["sector","company","disabled"],"nullable":false,"type":"string"},"latestTermsOfUse":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"company":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"latest":{"nullable":true,"type":"boolean"},"version":{"maxLength":5,"minLength":1,"nullable":true,"type":"string"},"publishedOn":{"nullable":true,"type":"string","format":"date-time"},"downloadUrl":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"type":{"enum":["termsofuse","privacystatement"],"nullable":false,"type":"string"},"languages":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"languageCode":{"maxLength":2,"minLength":2,"nullable":false,"type":"string"},"body":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"updateSummary":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"policy":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}}}},"latestPrivacyStatement":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"company":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"latest":{"nullable":true,"type":"boolean"},"version":{"maxLength":5,"minLength":1,"nullable":true,"type":"string"},"publishedOn":{"nullable":true,"type":"string","format":"date-time"},"downloadUrl":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"type":{"enum":["termsofuse","privacystatement"],"nullable":false,"type":"string"},"languages":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"languageCode":{"maxLength":2,"minLength":2,"nullable":false,"type":"string"},"body":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"updateSummary":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"policy":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}}}}}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"}],"security":[{"bearerToken":[]}]},"delete":{"tags":["MyUserInviteList"],"summary":"MyUserInviteList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/users/me/leave-companies":{"delete":{"tags":["MyUserLeaveCompanyList"],"summary":"MyUserLeaveCompanyList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":24,"minLength":24,"nullable":false,"pattern":"(\\d{4}-){4}\\d{4}","type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/users/me/otp-auth/disable":{"post":{"tags":["MyUserOtpAuthDisable"],"summary":"MyUserOtpAuthDisable","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingRequired"}],"security":[{"bearerToken":[]}]}},"/users/me/otp-auth/enable":{"post":{"tags":["MyUserOtpAuthEnable"],"summary":"MyUserOtpAuthEnable","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"secret":{"maxLength":16,"minLength":16,"nullable":false,"type":"string"}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"security":[{"bearerToken":[]}]}},"/users/me/otp-auth-sms/enable":{"post":{"tags":["MyUserOtpAuthSmsEnable"],"summary":"MyUserOtpAuthSmsEnable","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"secret":{"maxLength":16,"minLength":16,"nullable":false,"type":"string"}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"security":[{"bearerToken":[]}]}},"/users/me/otp-auth/verify":{"post":{"tags":["MyUserOtpAuthVerify"],"summary":"MyUserOtpAuthVerify","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingRequired"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"oneTimePassword":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"deviceName":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}},"required":["oneTimePassword","deviceName"]}}}},"security":[{"bearerToken":[]}]}},"/users/me/password":{"post":{"tags":["MyUserPassword"],"summary":"MyUserPassword","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingRequired"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"oldPassword":{"minLength":8,"nullable":false,"type":"string"},"newPassword":{"minLength":8,"nullable":false,"type":"string"},"deleteAccessTokens":{"nullable":false,"type":"boolean"}},"required":["oldPassword","newPassword","deleteAccessTokens"]}}}},"security":[{"bearerToken":[]}]}},"/users/me/push-devices/{publicId}":{"get":{"tags":["MyUserPushDevice"],"summary":"MyUserPushDevice","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"createdOn":{"nullable":false,"type":"string","format":"date-time"},"deactivated":{"nullable":false,"type":"boolean"},"deviceId":{"maxLength":36,"minLength":36,"nullable":false,"pattern":"[a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12}","type":"string"},"userAgent":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/users/me/push-devices/activate":{"post":{"tags":["MyUserPushDeviceActivate"],"summary":"MyUserPushDeviceActivate","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"deviceId":{"maxLength":36,"minLength":36,"nullable":false,"pattern":"[a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12}","type":"string"},"token":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}},"required":["deviceId"]}}}},"security":[{"bearerToken":[]}]}},"/users/me/push-devices/claim":{"post":{"tags":["MyUserPushDeviceClaim"],"summary":"MyUserPushDeviceClaim","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"deviceId":{"maxLength":36,"minLength":36,"nullable":false,"pattern":"[a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12}","type":"string"},"token":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"}},"required":["deviceId"]}}}},"security":[{"bearerToken":[]}]}},"/users/me/push-devices/deactivate":{"post":{"tags":["MyUserPushDeviceDeactivate"],"summary":"MyUserPushDeviceDeactivate","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"deviceId":{"maxLength":36,"minLength":36,"nullable":false,"pattern":"[a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12}","type":"string"}},"required":["deviceId"]}}}},"security":[{"bearerToken":[]}]}},"/users/me/push-devices":{"get":{"tags":["MyUserPushDeviceList"],"summary":"MyUserPushDeviceList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"createdOn":{"nullable":false,"type":"string","format":"date-time"},"deactivated":{"nullable":false,"type":"boolean"},"deviceId":{"maxLength":36,"minLength":36,"nullable":false,"pattern":"[a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12}","type":"string"},"userAgent":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"}],"security":[{"bearerToken":[]}]}},"/users/me/push-devices/release-claim":{"post":{"tags":["MyUserPushDeviceReleaseClaim"],"summary":"MyUserPushDeviceReleaseClaim","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"deviceId":{"maxLength":36,"minLength":36,"nullable":false,"pattern":"[a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12}","type":"string"}},"required":["deviceId"]}}}},"security":[{"bearerToken":[]}]}},"/users/me/vpn-configs":{"post":{"tags":["MyUserVpnConfigList"],"summary":"MyUserVpnConfigList","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"openvpnConfig":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"deviceId":{"maxLength":128,"minLength":1,"nullable":false,"type":"string"},"type":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"additionalSubnets":{"nullable":false,"type":"boolean"},"allowDataPublishing":{"nullable":false,"type":"boolean"},"allowDemoDevice":{"nullable":false,"type":"boolean"},"allowTemplating":{"nullable":false,"type":"boolean"},"allowReboot":{"nullable":false,"type":"boolean"},"configPush":{"nullable":false,"type":"boolean"},"configFileFormat":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"customServers":{"nullable":false,"type":"boolean"},"deviceIdFormat":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"httpProxyPort":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"latestFirmwareFile":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"code":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"notes":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"agentType":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"type":{"enum":["firmware"],"nullable":false,"type":"string"},"latest":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"offlineConfiguration":{"nullable":false,"type":"boolean"},"openvpnConfigMultiUse":{"nullable":false,"type":"boolean"},"purchasePrice":{"nullable":false,"type":"object","properties":{"gratis":{"nullable":false,"type":"boolean"}}},"router":{"nullable":false,"type":"boolean"},"stunnelSupport":{"nullable":false,"type":"boolean"},"wanPortForwardings":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"},"hasSecondWanPort":{"nullable":false,"type":"boolean"}}},"location":{"nullable":true,"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"latitude":{"nullable":false,"type":"string"},"longitude":{"nullable":false,"type":"string"}}},"geoLocation":{"nullable":true,"type":"object","properties":{"latitude":{"nullable":false,"type":"string"},"longitude":{"nullable":false,"type":"string"},"country":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"city":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"timeZone":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"custom":{"nullable":false,"type":"object"},"description":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"useStunnel":{"nullable":false,"type":"boolean"},"preferLocationOverGeoip":{"nullable":false,"type":"boolean"},"reRegistration":{"nullable":false,"type":"boolean"},"replaceRegistration":{"nullable":false,"type":"boolean"},"replaceMacAddress":{"maxLength":17,"minLength":0,"nullable":true,"pattern":"[0-9a-fA-F]{2}(:[0-9a-fA-F]{2}){5}","type":"string"},"fixedVpnAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"macAddress":{"maxLength":17,"minLength":1,"nullable":false,"type":"string"},"serialNumber":{"maxLength":128,"minLength":1,"nullable":false,"type":"string"},"pullCodeGeneratedOn":{"nullable":true,"type":"string","format":"date-time"},"controlKeyGeneratedOn":{"nullable":true,"type":"string","format":"date-time"},"lastSeenAgentUserAgent":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"value":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"configName":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"configVersion":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"hardware":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"hardwareCode":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"hardwareVersion":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"firmwareVersion":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"osName":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"osVersion":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"appName":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"appVersion":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"packageName":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"packageVersion":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"libixagentVersion":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"libixloggerVersion":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"logOnTrigger":{"nullable":false,"type":"boolean"},"alarming":{"nullable":false,"type":"boolean"},"dataMonitoring":{"nullable":false,"type":"boolean"},"wifi":{"nullable":false,"type":"boolean"},"remoteFirmwareUpgrade":{"nullable":false,"type":"boolean"},"staticMapping":{"nullable":false,"type":"boolean"},"stewardConfigPush":{"nullable":false,"type":"boolean"},"wanInterfaceEth0":{"nullable":false,"type":"boolean"},"wanInterfaceWifi0":{"nullable":false,"type":"boolean"},"wanInterfaceCell0":{"enum":["3G","4G","neither"],"nullable":false,"type":"string"},"multiWan":{"nullable":false,"type":"boolean"},"openvpnVersion":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"openvpnOccEnabled":{"nullable":false,"type":"boolean"},"openvpnOpensslVersion":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"}}},"networkValues":{"type":"array","items":{"nullable":false,"type":"object","properties":{"interface":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"value":{"type":"array","items":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}}}}},"networkReportedOn":{"nullable":true,"type":"string","format":"date-time"},"activeStatus":{"enum":["active","inactive"],"nullable":false,"type":"string"},"activationLicence":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"type":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"usageType":{"enum":["advanced-user-management","agent-registration-profile","agent-templates","alarming","api-integrations","app-engine-level-1","app-engine-level-2","app-engine-level-3","asset-management","card-view","connection-monitoring","controlled-devices","custom-branding","custom-domain","custom-fields","custom-legal","custom-legal-legacy","custom-sso","edge-app-management","ixagent","landing-page","live-data","logging","m2m-cloud-cluster","main-pages","mobile-app","mqtt-device","object-storage","premium-branding","rdp","remote-access","reporting","request-access","rtsp","scim","session-recording","sla","ssh","subgroups","temporary-access","vpn-access-rule","vpn-usage"],"nullable":false,"type":"string"},"companyLimit":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"scope":{"enum":["agent","company"],"nullable":false,"type":"string"}}},"serialNumber":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"expiresOn":{"nullable":true,"type":"string","format":"date-time"},"activated":{"nullable":false,"type":"boolean"},"trial":{"nullable":false,"type":"boolean"},"value":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"locked":{"nullable":true,"type":"boolean"},"maxRetentionPolicy":{"maxLength":255,"minLength":2,"nullable":true,"type":"string"},"bundle":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}},"pendingRegistration":{"nullable":false,"type":"boolean"},"card":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"activeVpnSession":{"nullable":true,"type":"object","properties":{"rscServer":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"vpnRange":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"supportedLayers":{"type":"array","items":{"enum":["tun","tap"],"nullable":false,"type":"string"}},"location":{"nullable":false,"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"latitude":{"nullable":false,"type":"string"},"longitude":{"nullable":false,"type":"string"}}}}},"startedOn":{"nullable":false,"type":"string","format":"date-time"},"sessionName":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"vpnAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"closed":{"nullable":false,"type":"boolean"}}},"vpnChangedOn":{"nullable":true,"type":"string","format":"date-time"},"mdrServer":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"mqttChangedOn":{"nullable":true,"type":"string","format":"date-time"},"loggingMdrServer":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"loggingMqttChangedOn":{"nullable":true,"type":"string","format":"date-time"},"lsiServer":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"company":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":24,"minLength":24,"nullable":false,"pattern":"(\\d{4}-){4}\\d{4}","type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"controlledBy":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":24,"minLength":24,"nullable":false,"pattern":"(\\d{4}-){4}\\d{4}","type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"vpnAudience":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"custom":{"nullable":false,"type":"object"},"default":{"nullable":false,"type":"boolean"},"type":{"enum":["alarm","page","service"],"nullable":true,"type":"string"}}},"vpnRequireAccessApproval":{"nullable":false,"type":"boolean"},"vpnAccessRules":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"audience":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"ipAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"netMask":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}}}},"vpnVisibleInMobileApp":{"nullable":false,"type":"boolean"},"vpnVisibleOnWeb":{"nullable":false,"type":"boolean"},"dataAudience":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"custom":{"nullable":false,"type":"object"},"default":{"nullable":false,"type":"boolean"},"type":{"enum":["alarm","page","service"],"nullable":true,"type":"string"}}},"memberships":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"group":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}},"rateLimiting":{"nullable":false,"type":"object","properties":{"configMqttCommandLimit":{"enum":["soft","hard","lock"],"nullable":true,"type":"string"},"configMqttCommandCounter":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"configMqttCommandLastHit":{"nullable":true,"type":"string","format":"date-time"},"configMqttDataLimit":{"enum":["soft","hard","lock"],"nullable":true,"type":"string"},"configMqttDataCounter":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"configMqttDataLastHit":{"nullable":true,"type":"string","format":"date-time"},"configOpenvpnLimit":{"enum":["soft","hard","lock"],"nullable":true,"type":"string"},"configOpenvpnCounter":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"configOpenvpnLastHit":{"nullable":true,"type":"string","format":"date-time"}}},"vpnProtocol":{"enum":["udp","tcp"],"nullable":false,"type":"string"},"config":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"configFileServer":{"maxLength":4294967295,"minLength":0,"nullable":true,"type":"string"},"configPushedOn":{"nullable":true,"type":"string","format":"date-time"},"configFileReported":{"maxLength":4294967295,"minLength":0,"nullable":true,"type":"string"},"configFileReportedWlanKeyEnabled":{"nullable":false,"type":"boolean"},"configFileReportedCellularPasswordEnabled":{"nullable":false,"type":"boolean"},"configReportedOn":{"nullable":true,"type":"string","format":"date-time"},"differentConfigs":{"nullable":false,"type":"boolean"},"differentWanConfigs":{"nullable":false,"type":"boolean"},"stewardConfigFileServer":{"maxLength":4294967295,"minLength":0,"nullable":true,"type":"string"},"stewardConfigFileReported":{"maxLength":4294967295,"minLength":0,"nullable":true,"type":"string"},"stewardConfigReportedOn":{"nullable":true,"type":"string","format":"date-time"},"differentStewardConfigs":{"nullable":false,"type":"boolean"},"routerLan":{"nullable":false,"type":"object","properties":{"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"ipAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"netMask":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"network":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"dhcpServerEnabled":{"nullable":false,"type":"boolean"},"dhcpServerRangeFrom":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"dhcpServerRangeTo":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"gatewayLessRouting":{"nullable":false,"type":"boolean"},"forwardLanWan":{"enum":["neither","public","private","both"],"nullable":false,"type":"string"},"forwardLanWan2":{"enum":["neither","public","private","both"],"nullable":false,"type":"string"},"wlanEnable":{"nullable":true,"type":"boolean"},"wlanSsid":{"maxLength":32,"minLength":0,"nullable":true,"type":"string"},"wlanKey":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"wlanChannel":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"bacnetBbmd":{"type":"array","items":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}},"udpBroadcastRelayPort":{"type":"array","items":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}}}},"routerVpn":{"nullable":false,"type":"object","properties":{"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"sourceNatEnabled":{"nullable":false,"type":"boolean"}}},"routerWan":{"nullable":false,"type":"object","properties":{"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"multiwanPolicy":{"enum":["eth_cell_wifi","cell_eth_wifi","eth_wifi_cell","wifi_eth_cell","cell_wifi_eth","wifi_cell_eth"],"nullable":true,"type":"string"},"ipUseDhcp":{"nullable":true,"type":"boolean"},"ipAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"ipGateway":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"ipNetMask":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"dnsServers":{"type":"array","items":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}},"dnsRebindProtectionEnabled":{"nullable":true,"type":"boolean"},"cellularApn":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"cellularPincode":{"maxLength":8,"minLength":0,"nullable":true,"type":"string"},"cellularMtu":{"maximum":1500,"minimum":576,"nullable":true,"type":"integer","format":"int32"},"digitalInputMode":{"enum":["disable_vpn_high","disable_vpn_low","disable_wan_high","disable_wan_low"],"nullable":true,"type":"string"},"wanTrackInterval":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"wanTrackIps":{"type":"array","items":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}},"wlanTrackInterval":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"wlanTrackIps":{"type":"array","items":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}},"cellularTrackInterval":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"cellularTrackIps":{"type":"array","items":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}},"httpProxyAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"httpProxyPort":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"httpProxyAuthentication":{"enum":["none","basic","ntlm"],"nullable":true,"type":"string"},"httpProxyUsername":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"httpProxyIsSocks5":{"nullable":true,"type":"boolean"},"wlanSsid":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"wlanIpUseDhcp":{"nullable":true,"type":"boolean"},"wlanIpAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"wlanIpGateway":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"wlanIpNetMask":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"wlanDnsServers":{"type":"array","items":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}},"cellularUsername":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"}}},"routerDisplay":{"nullable":false,"type":"object","properties":{"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"lockEnabled":{"nullable":false,"type":"boolean"},"lockCode":{"maxLength":4,"minLength":4,"nullable":true,"pattern":"[0-9]+","type":"string"}}},"routerAdditionalSubnets":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"networkAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"networkMask":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"gatewayAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}},"routerPortForwards":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"interface":{"enum":["VPN","WAN","WAN2"],"nullable":false,"type":"string"},"targetIpAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"targetPort":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"externalPort":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}},"routerNtpServers":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"server":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}}},"demoDevice":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"expiresOn":{"nullable":false,"type":"string","format":"date-time"},"agentType":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"additionalSubnets":{"nullable":false,"type":"boolean"},"allowDataPublishing":{"nullable":false,"type":"boolean"},"allowDemoDevice":{"nullable":false,"type":"boolean"},"allowTemplating":{"nullable":false,"type":"boolean"},"allowReboot":{"nullable":false,"type":"boolean"},"configPush":{"nullable":false,"type":"boolean"},"configFileFormat":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"customServers":{"nullable":false,"type":"boolean"},"deviceIdFormat":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"httpProxyPort":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"latestFirmwareFile":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"code":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"notes":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"agentType":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"type":{"enum":["firmware"],"nullable":false,"type":"string"},"latest":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"offlineConfiguration":{"nullable":false,"type":"boolean"},"openvpnConfigMultiUse":{"nullable":false,"type":"boolean"},"purchasePrice":{"nullable":false,"type":"object","properties":{"gratis":{"nullable":false,"type":"boolean"}}},"router":{"nullable":false,"type":"boolean"},"stunnelSupport":{"nullable":false,"type":"boolean"},"wanPortForwardings":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"},"hasSecondWanPort":{"nullable":false,"type":"boolean"}}},"dmvServer":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}},"connectedUsers":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}},"loggingApp":{"nullable":false,"type":"object","properties":{"licence":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"type":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"usageType":{"enum":["advanced-user-management","agent-registration-profile","agent-templates","alarming","api-integrations","app-engine-level-1","app-engine-level-2","app-engine-level-3","asset-management","card-view","connection-monitoring","controlled-devices","custom-branding","custom-domain","custom-fields","custom-legal","custom-legal-legacy","custom-sso","edge-app-management","ixagent","landing-page","live-data","logging","m2m-cloud-cluster","main-pages","mobile-app","mqtt-device","object-storage","premium-branding","rdp","remote-access","reporting","request-access","rtsp","scim","session-recording","sla","ssh","subgroups","temporary-access","vpn-access-rule","vpn-usage"],"nullable":false,"type":"string"},"companyLimit":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"scope":{"enum":["agent","company"],"nullable":false,"type":"string"}}},"serialNumber":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"expiresOn":{"nullable":true,"type":"string","format":"date-time"},"activated":{"nullable":false,"type":"boolean"},"trial":{"nullable":false,"type":"boolean"},"value":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"locked":{"nullable":true,"type":"boolean"},"maxRetentionPolicy":{"maxLength":255,"minLength":2,"nullable":true,"type":"string"},"agent":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"deviceId":{"maxLength":128,"minLength":1,"nullable":false,"type":"string"},"type":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"location":{"nullable":false,"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"latitude":{"nullable":false,"type":"string"},"longitude":{"nullable":false,"type":"string"}}},"geoLocation":{"nullable":false,"type":"object","properties":{"latitude":{"nullable":false,"type":"string"},"longitude":{"nullable":false,"type":"string"},"country":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"city":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"custom":{"nullable":false,"type":"object"}}},"hasAgent":{"nullable":false,"type":"boolean"},"agentType":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"additionalSubnets":{"nullable":false,"type":"boolean"},"allowDataPublishing":{"nullable":false,"type":"boolean"},"allowDemoDevice":{"nullable":false,"type":"boolean"},"allowTemplating":{"nullable":false,"type":"boolean"},"allowReboot":{"nullable":false,"type":"boolean"},"configPush":{"nullable":false,"type":"boolean"},"configFileFormat":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"customServers":{"nullable":false,"type":"boolean"},"deviceIdFormat":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"httpProxyPort":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"latestFirmwareFile":{"nullable":false,"type":"object"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"offlineConfiguration":{"nullable":false,"type":"boolean"},"openvpnConfigMultiUse":{"nullable":false,"type":"boolean"},"purchasePrice":{"nullable":false,"type":"object"},"router":{"nullable":false,"type":"boolean"},"stunnelSupport":{"nullable":false,"type":"boolean"},"wanPortForwardings":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"},"hasSecondWanPort":{"nullable":false,"type":"boolean"}}},"bundle":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}},"enabled":{"nullable":false,"type":"boolean"}}},"valuesPerHour":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"alarmingApp":{"nullable":false,"type":"object","properties":{"licence":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"type":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"usageType":{"enum":["advanced-user-management","agent-registration-profile","agent-templates","alarming","api-integrations","app-engine-level-1","app-engine-level-2","app-engine-level-3","asset-management","card-view","connection-monitoring","controlled-devices","custom-branding","custom-domain","custom-fields","custom-legal","custom-legal-legacy","custom-sso","edge-app-management","ixagent","landing-page","live-data","logging","m2m-cloud-cluster","main-pages","mobile-app","mqtt-device","object-storage","premium-branding","rdp","remote-access","reporting","request-access","rtsp","scim","session-recording","sla","ssh","subgroups","temporary-access","vpn-access-rule","vpn-usage"],"nullable":false,"type":"string"},"companyLimit":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"scope":{"enum":["agent","company"],"nullable":false,"type":"string"}}},"serialNumber":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"expiresOn":{"nullable":true,"type":"string","format":"date-time"},"activated":{"nullable":false,"type":"boolean"},"trial":{"nullable":false,"type":"boolean"},"value":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"locked":{"nullable":true,"type":"boolean"},"maxRetentionPolicy":{"maxLength":255,"minLength":2,"nullable":true,"type":"string"},"agent":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"deviceId":{"maxLength":128,"minLength":1,"nullable":false,"type":"string"},"type":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"location":{"nullable":false,"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"latitude":{"nullable":false,"type":"string"},"longitude":{"nullable":false,"type":"string"}}},"geoLocation":{"nullable":false,"type":"object","properties":{"latitude":{"nullable":false,"type":"string"},"longitude":{"nullable":false,"type":"string"},"country":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"city":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"custom":{"nullable":false,"type":"object"}}},"hasAgent":{"nullable":false,"type":"boolean"},"agentType":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"additionalSubnets":{"nullable":false,"type":"boolean"},"allowDataPublishing":{"nullable":false,"type":"boolean"},"allowDemoDevice":{"nullable":false,"type":"boolean"},"allowTemplating":{"nullable":false,"type":"boolean"},"allowReboot":{"nullable":false,"type":"boolean"},"configPush":{"nullable":false,"type":"boolean"},"configFileFormat":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"customServers":{"nullable":false,"type":"boolean"},"deviceIdFormat":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"httpProxyPort":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"latestFirmwareFile":{"nullable":false,"type":"object"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"offlineConfiguration":{"nullable":false,"type":"boolean"},"openvpnConfigMultiUse":{"nullable":false,"type":"boolean"},"purchasePrice":{"nullable":false,"type":"object"},"router":{"nullable":false,"type":"boolean"},"stunnelSupport":{"nullable":false,"type":"boolean"},"wanPortForwardings":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"},"hasSecondWanPort":{"nullable":false,"type":"boolean"}}},"bundle":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}},"enabled":{"nullable":false,"type":"boolean"}}},"lanWanAccessRules":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"sourceIpAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"sourceMacAddress":{"maxLength":17,"minLength":17,"nullable":true,"pattern":"[0-9a-fA-F]{2}(:[0-9a-fA-F]{2}){5}","type":"string"},"destinationPort":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"destinationIpAddress":{"maxLength":19,"minLength":7,"nullable":true,"pattern":"\\d{1,3}(\\.\\d{1,3}){3}(\\/\\d{1,3})?","type":"string"},"protocol":{"enum":["all","tcp","udp","icmp","ah","ax.25","dccp","ddp","egp","eigrp","encap","esp","etherip","fc","ggp","gre","hmp","idpr-cmtp","idrp","igmp","igp","ipcomp","ipencap","ipip","ipv6","ipv6-frag","ipv6-icmp","ipv6-nonxt","ipv6-opts","ipv6-route","isis","iso-tp4","l2tp","ospf","pim","pup","rdp","rspf","rsvp","sctp","skip","st","vmtp","vrrp","xns-idp","xtp"],"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"}}}},"oneToOneNatRules":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"type":{"enum":["wan","wlan","vpn"],"nullable":false,"type":"string"},"virtualIpAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"destinationIpAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"protocol":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"port":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"sourceIpAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"}}}},"devices":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"ipAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"macAddress":{"maxLength":17,"minLength":17,"nullable":true,"pattern":"[0-9a-fA-F]{2}(:[0-9a-fA-F]{2}){5}","type":"string"},"customAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"dataSources":{"type":"array","items":{"nullable":false,"type":"object","properties":{"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"continueLoggingOnError":{"nullable":true,"type":"boolean"},"device":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"gracePeriod":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"slug":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"^[a-zA-Z0-9_\\[\\]-]+$","type":"string"},"disabled":{"nullable":false,"type":"boolean"},"protocol":{"oneOf":[{"type":"object","properties":{"publicId":{"enum":["custom"],"nullable":false,"type":"string"},"password":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}},"required":["publicId","password"]},{"type":"object","properties":{"publicId":{"enum":["modbus"],"nullable":false,"type":"string"},"slave":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"format":{"enum":["ABCD","BADC","CDAB","DCBA"],"nullable":true,"type":"string"},"readMode":{"enum":["single_value","consecutive_values","gapped_values"],"nullable":true,"type":"string"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["siemens-step7"],"nullable":false,"type":"string"},"pdu":{"maximum":2147483647,"minimum":-2147483648,"nullable":true,"type":"integer","format":"int32"},"rack":{"maximum":7,"nullable":true,"type":"integer","format":"int32"},"slot":{"maximum":31,"nullable":true,"type":"integer","format":"int32"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["opc-ua"],"nullable":false,"type":"string"},"authenticationType":{"enum":["anonymous","username","certificate"],"nullable":false,"type":"string"},"username":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"password":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"securityMode":{"enum":["sign","signandencrypt"],"nullable":true,"type":"string"},"securityPolicy":{"enum":["basic256sha256","aes128_sha256_rsaoaep","aes256_sha256_rsapss"],"nullable":true,"type":"string"}},"required":["publicId","authenticationType"]},{"type":"object","properties":{"publicId":{"enum":["ethernet-ip"],"nullable":false,"type":"string"},"cpu":{"enum":["compactlogix","micro800","micrologix","micrologix800","omron"],"nullable":false,"type":"string"},"rack":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"slot":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"}},"required":["publicId","cpu"]},{"type":"object","properties":{"publicId":{"enum":["host"],"nullable":false,"type":"string"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["bacnet-ip"],"nullable":false,"type":"string"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["mc-protocol"],"nullable":false,"type":"string"},"cpu":{"enum":["FX5U","IQR","L","Q","QNUCPU"],"nullable":true,"type":"string"},"protocol":{"enum":["TCP","UDP"],"nullable":true,"type":"string"},"networkNo":{"maximum":255,"nullable":true,"type":"integer","format":"int32"},"pcNo":{"maxLength":2,"minLength":1,"nullable":true,"pattern":"[A-Za-z0-9]+","type":"string"},"requestDestIoNr":{"maxLength":4,"minLength":1,"nullable":true,"pattern":"[A-Za-z0-9]+","type":"string"},"requestDestModuleStatNr":{"maximum":255,"nullable":true,"type":"integer","format":"int32"},"authenticationType":{"enum":["none","password"],"nullable":true,"type":"string"},"password":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"reconnectDelay":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"maxBlocks":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"maxPoints":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"}},"required":["publicId"]}]},"port":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"pullDelay":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"valuesPerHour":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"mqttTopic":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"mqttBrokerClient":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}}}}},"servers":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"type":{"enum":["http","rdp","rtsp","ssh","vnc","websocket"],"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"port":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"username":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"password":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"hasPassword":{"nullable":false,"type":"boolean"},"authDomain":{"maxLength":253,"minLength":4,"nullable":true,"pattern":".+(\\..[^.]+)","type":"string"},"landingPage":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"connectionQuality":{"enum":["low","normal","high"],"nullable":true,"type":"string"},"readOnly":{"nullable":true,"type":"boolean"},"vncRightClickOnTouchHold":{"nullable":false,"type":"boolean"},"vncEncoding":{"enum":["copyrect","corre","hextile","raw","rre","tight","ultra","ultrazip","zlib","zlibhex","zrle","zywrle"],"nullable":true,"type":"string"},"useSsl":{"nullable":false,"type":"boolean"},"visibleInMobileApp":{"nullable":false,"type":"boolean"},"visibleOnWeb":{"nullable":false,"type":"boolean"},"httpAuthenticationType":{"enum":["ntlm","basic","digest"],"nullable":true,"type":"string"},"recordSessions":{"nullable":true,"type":"boolean"},"audience":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"requireAccessApproval":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"device":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"serviceGroup":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"template":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"type":{"enum":["http","rdp","rtsp","ssh","vnc","websocket"],"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"port":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"username":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"password":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"hasPassword":{"nullable":false,"type":"boolean"},"authDomain":{"maxLength":253,"minLength":4,"nullable":true,"pattern":".+(\\..[^.]+)","type":"string"},"landingPage":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"connectionQuality":{"enum":["low","normal","high"],"nullable":true,"type":"string"},"readOnly":{"nullable":true,"type":"boolean"},"vncRightClickOnTouchHold":{"nullable":false,"type":"boolean"},"vncEncoding":{"enum":["copyrect","corre","hextile","raw","rre","tight","ultra","ultrazip","zlib","zlibhex","zrle","zywrle"],"nullable":true,"type":"string"},"useSsl":{"nullable":false,"type":"boolean"},"visibleInMobileApp":{"nullable":false,"type":"boolean"},"visibleOnWeb":{"nullable":false,"type":"boolean"},"httpAuthenticationType":{"enum":["ntlm","basic","digest"],"nullable":true,"type":"string"},"recordSessions":{"nullable":true,"type":"boolean"},"audience":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"requireAccessApproval":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"}}}}}},"dataSources":{"type":"array","items":{"nullable":false,"type":"object","properties":{"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"continueLoggingOnError":{"nullable":true,"type":"boolean"},"device":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"gracePeriod":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"slug":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"^[a-zA-Z0-9_\\[\\]-]+$","type":"string"},"disabled":{"nullable":false,"type":"boolean"},"protocol":{"oneOf":[{"type":"object","properties":{"publicId":{"enum":["custom"],"nullable":false,"type":"string"},"password":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}},"required":["publicId","password"]},{"type":"object","properties":{"publicId":{"enum":["modbus"],"nullable":false,"type":"string"},"slave":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"format":{"enum":["ABCD","BADC","CDAB","DCBA"],"nullable":true,"type":"string"},"readMode":{"enum":["single_value","consecutive_values","gapped_values"],"nullable":true,"type":"string"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["siemens-step7"],"nullable":false,"type":"string"},"pdu":{"maximum":2147483647,"minimum":-2147483648,"nullable":true,"type":"integer","format":"int32"},"rack":{"maximum":7,"nullable":true,"type":"integer","format":"int32"},"slot":{"maximum":31,"nullable":true,"type":"integer","format":"int32"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["opc-ua"],"nullable":false,"type":"string"},"authenticationType":{"enum":["anonymous","username","certificate"],"nullable":false,"type":"string"},"username":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"password":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"securityMode":{"enum":["sign","signandencrypt"],"nullable":true,"type":"string"},"securityPolicy":{"enum":["basic256sha256","aes128_sha256_rsaoaep","aes256_sha256_rsapss"],"nullable":true,"type":"string"}},"required":["publicId","authenticationType"]},{"type":"object","properties":{"publicId":{"enum":["ethernet-ip"],"nullable":false,"type":"string"},"cpu":{"enum":["compactlogix","micro800","micrologix","micrologix800","omron"],"nullable":false,"type":"string"},"rack":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"slot":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"}},"required":["publicId","cpu"]},{"type":"object","properties":{"publicId":{"enum":["host"],"nullable":false,"type":"string"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["bacnet-ip"],"nullable":false,"type":"string"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["mc-protocol"],"nullable":false,"type":"string"},"cpu":{"enum":["FX5U","IQR","L","Q","QNUCPU"],"nullable":true,"type":"string"},"protocol":{"enum":["TCP","UDP"],"nullable":true,"type":"string"},"networkNo":{"maximum":255,"nullable":true,"type":"integer","format":"int32"},"pcNo":{"maxLength":2,"minLength":1,"nullable":true,"pattern":"[A-Za-z0-9]+","type":"string"},"requestDestIoNr":{"maxLength":4,"minLength":1,"nullable":true,"pattern":"[A-Za-z0-9]+","type":"string"},"requestDestModuleStatNr":{"maximum":255,"nullable":true,"type":"integer","format":"int32"},"authenticationType":{"enum":["none","password"],"nullable":true,"type":"string"},"password":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"reconnectDelay":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"maxBlocks":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"maxPoints":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"}},"required":["publicId"]}]},"port":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"pullDelay":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"valuesPerHour":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"mqttTopic":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"mqttBrokerClient":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}},"pageLinks":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"asset":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"menuItem":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"page":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"audience":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"custom":{"nullable":false,"type":"object"},"default":{"nullable":false,"type":"boolean"},"type":{"enum":["alarm","page","service"],"nullable":true,"type":"string"}}},"group":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"asset":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"menuItem":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"custom":{"nullable":false,"type":"object"}}}},"scheduledAccessRequests":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"user":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"approver":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"approverCompany":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"vpn":{"nullable":false,"type":"boolean"},"servers":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}},"start":{"nullable":false,"type":"string","format":"date-time"},"end":{"nullable":false,"type":"string","format":"date-time"},"status":{"enum":["approved","pending","rejected","revoked"],"nullable":false,"type":"string"},"reason":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"createdOn":{"nullable":false,"type":"string","format":"date-time"},"updatedOn":{"nullable":true,"type":"string","format":"date-time"},"allowedApprovers":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}},"reviewExpiresOn":{"nullable":true,"type":"string","format":"date-time"}}}},"assets":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}},"registrationProfile":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":24,"minLength":24,"nullable":false,"pattern":"(\\d{4}-){4}\\d{4}","type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"agentActivationName":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"}}},"vpnLocked":{"nullable":false,"type":"boolean"},"webAccessLocked":{"nullable":false,"type":"boolean"},"appliedTemplateVersion":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"createdOn":{"nullable":false,"type":"string","format":"date-time"},"createdBy":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"company":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"description":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"agentTemplate":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"number":{"maxLength":64,"minLength":1,"nullable":false,"type":"string"}}}}},"company":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":24,"minLength":24,"nullable":false,"pattern":"(\\d{4}-){4}\\d{4}","type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"custom":{"nullable":false,"type":"object"},"branding":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"fqdn":{"maxLength":253,"minLength":4,"nullable":true,"pattern":".+(\\..[^.]+)","type":"string"},"theme":{"nullable":true,"type":"object","properties":{"primaryColor":{"maxLength":7,"minLength":6,"nullable":false,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"primaryTextColor":{"maxLength":7,"minLength":6,"nullable":false,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"accentColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"accentTextColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"headerColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"headerLineColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"menuColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"menuTextColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"pageColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"pageTextColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"cardColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"cardTextColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"logoHasBackgroundColor":{"nullable":false,"type":"boolean"},"logoOnHeaderColorSpec":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"}}},"appleTouchIcon":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"favicon":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"logo":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"logoDark":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"appleAppStoreLink":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"googlePlayStoreLink":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"landingPageComponentTemplate":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"company":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"version":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"author":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"licence":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"url":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"sheetSettings":{"nullable":true,"type":"object","properties":{"minCols":{"maximum":11,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"defaultCols":{"maximum":11,"minimum":1,"nullable":true,"type":"integer","format":"int32"},"maxCols":{"maximum":11,"minimum":1,"nullable":true,"type":"integer","format":"int32"},"minRows":{"maximum":11,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"defaultRows":{"maximum":11,"minimum":1,"nullable":true,"type":"integer","format":"int32"},"maxRows":{"maximum":11,"minimum":1,"nullable":true,"type":"integer","format":"int32"}}},"cardSettings":{"nullable":true,"type":"object","properties":{"minHeight":{"maximum":65535,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"defaultHeight":{"maximum":65535,"minimum":1,"nullable":true,"type":"integer","format":"int32"},"maxHeight":{"maximum":65535,"minimum":1,"nullable":true,"type":"integer","format":"int32"}}},"inputs":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"draft":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"published":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"category":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}}},"configuredVersion":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"number":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"\\d+","type":"string"},"mainPath":{"maxLength":255,"minLength":4,"nullable":false,"type":"string"}}},"backendComponent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"static":{"nullable":false,"type":"boolean"},"intent":{"type":"array","items":{"enum":["asset-configuration","landing-page","main-page"],"nullable":false,"type":"string"}},"private":{"nullable":false,"type":"boolean"}}},"custom":{"nullable":false,"type":"object"}}},"customTermsOfUse":{"enum":["sector","company","disabled"],"nullable":false,"type":"string"},"customPrivacyStatement":{"enum":["sector","company","disabled"],"nullable":false,"type":"string"},"latestTermsOfUse":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"company":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"latest":{"nullable":true,"type":"boolean"},"version":{"maxLength":5,"minLength":1,"nullable":true,"type":"string"},"publishedOn":{"nullable":true,"type":"string","format":"date-time"},"downloadUrl":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"type":{"enum":["termsofuse","privacystatement"],"nullable":false,"type":"string"},"languages":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"languageCode":{"maxLength":2,"minLength":2,"nullable":false,"type":"string"},"body":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"updateSummary":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"policy":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}}}},"latestPrivacyStatement":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"company":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"latest":{"nullable":true,"type":"boolean"},"version":{"maxLength":5,"minLength":1,"nullable":true,"type":"string"},"publishedOn":{"nullable":true,"type":"string","format":"date-time"},"downloadUrl":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"type":{"enum":["termsofuse","privacystatement"],"nullable":false,"type":"string"},"languages":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"languageCode":{"maxLength":2,"minLength":2,"nullable":false,"type":"string"},"body":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"updateSummary":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"policy":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}}}}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"hostname":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"type":{"enum":["openvpn"],"nullable":false,"type":"string"},"networkLayer":{"enum":["tap","tun"],"nullable":false,"type":"string"},"transportProtocol":{"enum":["udp","tcp","stunnel"],"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"addRoutes":{"nullable":false,"type":"boolean"},"rsaPubKey":{"nullable":false,"type":"string"}},"required":["type","networkLayer","transportProtocol","agent","addRoutes"]}}}},"security":[{"bearerToken":[]}]}},"/oci-registries/{publicId}":{"get":{"tags":["OciRegistry"],"summary":"OciRegistry","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"server":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"username":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"patch":{"tags":["OciRegistry"],"summary":"OciRegistry","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"username":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"password":{"maxLength":128,"minLength":1,"nullable":false,"type":"string"}}}}}},"security":[{"bearerToken":[]}]},"delete":{"tags":["OciRegistry"],"summary":"OciRegistry","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/oci-registries":{"get":{"tags":["OciRegistryList"],"summary":"OciRegistryList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"server":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"username":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"}],"security":[{"bearerToken":[]}]},"post":{"tags":["OciRegistryList"],"summary":"OciRegistryList","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"server":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"username":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"password":{"maxLength":128,"minLength":1,"nullable":false,"type":"string"}},"required":["server","username","password"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"patch":{"tags":["OciRegistryList"],"summary":"OciRegistryList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"username":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"password":{"maxLength":128,"minLength":1,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"delete":{"tags":["OciRegistryList"],"summary":"OciRegistryList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/pages/{publicId}":{"get":{"tags":["Page"],"summary":"Page","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"applicationType":{"enum":["sheet","card","report"],"nullable":false,"type":"string"},"company":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"group":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"draft":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"page":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"title":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"components":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"pageVersion":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"template":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"boundVersion":{"nullable":true,"type":"object","properties":{"template":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"number":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"\\d+","type":"string"},"mainPath":{"maxLength":255,"minLength":4,"nullable":false,"type":"string"},"notes":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"publishedOn":{"nullable":true,"type":"string","format":"date-time"},"createdOn":{"nullable":false,"type":"string","format":"date-time"},"createdBy":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}},"dimensions":{"oneOf":[{"type":"object","properties":{"type":{"enum":["sheet"],"nullable":false,"type":"string"},"left":{"maximum":11,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":71,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":12,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":72,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"mobileHeight":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"mobileOrder":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"mobileLeft":{"maximum":11,"nullable":true,"type":"integer","format":"int32"},"mobileCols":{"maximum":12,"minimum":1,"nullable":true,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]},{"type":"object","properties":{"type":{"enum":["card"],"nullable":false,"type":"string"},"height":{"maximum":65535,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}},"required":["type","height","order"]},{"type":"object","properties":{"type":{"enum":["report"],"nullable":false,"type":"string"},"left":{"maximum":7,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":15,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":8,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":16,"minimum":1,"nullable":false,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]},{"type":"object","properties":{"type":{"enum":["report-portrait"],"nullable":false,"type":"string"},"left":{"maximum":5,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":15,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":6,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":16,"minimum":1,"nullable":false,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]},{"type":"object","properties":{"type":{"enum":["report-landscape"],"nullable":false,"type":"string"},"left":{"maximum":7,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":10,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":8,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":11,"minimum":1,"nullable":false,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]}]},"inputs":{"maxLength":16777215,"minLength":0,"nullable":false,"type":"string"},"pagePage":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"pageVersion":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}}}}}},"previewAgent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"previewAsset":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"periodSpec":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"periodSelectorEnabled":{"nullable":false,"type":"boolean"},"defaultRefreshRate":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"createdOn":{"nullable":false,"type":"string","format":"date-time"},"createdBy":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"updatedOn":{"nullable":true,"type":"string","format":"date-time"},"updatedBy":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"pagePages":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"pageVersion":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}}}},"custom":{"nullable":false,"type":"object"}}},"published":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"page":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"title":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"components":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"pageVersion":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"template":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"boundVersion":{"nullable":true,"type":"object","properties":{"template":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"number":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"\\d+","type":"string"},"mainPath":{"maxLength":255,"minLength":4,"nullable":false,"type":"string"},"notes":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"publishedOn":{"nullable":true,"type":"string","format":"date-time"},"createdOn":{"nullable":false,"type":"string","format":"date-time"},"createdBy":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}},"dimensions":{"oneOf":[{"type":"object","properties":{"type":{"enum":["sheet"],"nullable":false,"type":"string"},"left":{"maximum":11,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":71,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":12,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":72,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"mobileHeight":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"mobileOrder":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"mobileLeft":{"maximum":11,"nullable":true,"type":"integer","format":"int32"},"mobileCols":{"maximum":12,"minimum":1,"nullable":true,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]},{"type":"object","properties":{"type":{"enum":["card"],"nullable":false,"type":"string"},"height":{"maximum":65535,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}},"required":["type","height","order"]},{"type":"object","properties":{"type":{"enum":["report"],"nullable":false,"type":"string"},"left":{"maximum":7,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":15,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":8,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":16,"minimum":1,"nullable":false,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]},{"type":"object","properties":{"type":{"enum":["report-portrait"],"nullable":false,"type":"string"},"left":{"maximum":5,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":15,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":6,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":16,"minimum":1,"nullable":false,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]},{"type":"object","properties":{"type":{"enum":["report-landscape"],"nullable":false,"type":"string"},"left":{"maximum":7,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":10,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":8,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":11,"minimum":1,"nullable":false,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]}]},"inputs":{"maxLength":16777215,"minLength":0,"nullable":false,"type":"string"},"pagePage":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"pageVersion":{"nullable":false,"type":"object"},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}}}}}},"previewAgent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"previewAsset":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"periodSpec":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"periodSelectorEnabled":{"nullable":false,"type":"boolean"},"defaultRefreshRate":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"createdOn":{"nullable":false,"type":"string","format":"date-time"},"createdBy":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"updatedOn":{"nullable":true,"type":"string","format":"date-time"},"updatedBy":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"pagePages":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"pageVersion":{"nullable":false,"type":"object"},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}}}},"custom":{"nullable":false,"type":"object"}}},"default":{"nullable":false,"type":"boolean"},"static":{"nullable":false,"type":"boolean"},"orientation":{"enum":["portrait","landscape"],"nullable":true,"type":"string"},"labels":{"type":"array","items":{"nullable":false,"type":"object","properties":{"color":{"maxLength":7,"minLength":6,"nullable":false,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"company":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}},"custom":{"nullable":false,"type":"object"}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"patch":{"tags":["Page"],"summary":"Page","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"draft":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"published":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"static":{"nullable":false,"type":"boolean"},"group":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"labels":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}},"custom":{"nullable":false,"type":"object"}}}}}},"security":[{"bearerToken":[]}]},"delete":{"tags":["Page"],"summary":"Page","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/page-components/{publicId}":{"get":{"tags":["PageComponent"],"summary":"PageComponent","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"pageVersion":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"template":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"boundVersion":{"nullable":true,"type":"object","properties":{"template":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"number":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"\\d+","type":"string"},"mainPath":{"maxLength":255,"minLength":4,"nullable":false,"type":"string"},"notes":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"publishedOn":{"nullable":true,"type":"string","format":"date-time"},"createdOn":{"nullable":false,"type":"string","format":"date-time"},"createdBy":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}},"dimensions":{"oneOf":[{"type":"object","properties":{"type":{"enum":["sheet"],"nullable":false,"type":"string"},"left":{"maximum":11,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":71,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":12,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":72,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"mobileHeight":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"mobileOrder":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"mobileLeft":{"maximum":11,"nullable":true,"type":"integer","format":"int32"},"mobileCols":{"maximum":12,"minimum":1,"nullable":true,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]},{"type":"object","properties":{"type":{"enum":["card"],"nullable":false,"type":"string"},"height":{"maximum":65535,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}},"required":["type","height","order"]},{"type":"object","properties":{"type":{"enum":["report"],"nullable":false,"type":"string"},"left":{"maximum":7,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":15,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":8,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":16,"minimum":1,"nullable":false,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]},{"type":"object","properties":{"type":{"enum":["report-portrait"],"nullable":false,"type":"string"},"left":{"maximum":5,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":15,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":6,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":16,"minimum":1,"nullable":false,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]},{"type":"object","properties":{"type":{"enum":["report-landscape"],"nullable":false,"type":"string"},"left":{"maximum":7,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":10,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":8,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":11,"minimum":1,"nullable":false,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]}]},"inputs":{"maxLength":16777215,"minLength":0,"nullable":false,"type":"string"},"pagePage":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"pageVersion":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"patch":{"tags":["PageComponent"],"summary":"PageComponent","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"boundVersion":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"dimensions":{"oneOf":[{"type":"object","properties":{"type":{"enum":["sheet"],"nullable":false,"type":"string"},"left":{"maximum":11,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":71,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":12,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":72,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"mobileHeight":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"mobileOrder":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"mobileLeft":{"maximum":11,"nullable":true,"type":"integer","format":"int32"},"mobileCols":{"maximum":12,"minimum":1,"nullable":true,"type":"integer","format":"int32"}},"required":["type"]},{"type":"object","properties":{"type":{"enum":["card"],"nullable":false,"type":"string"},"height":{"maximum":65535,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}},"required":["type"]},{"type":"object","properties":{"type":{"enum":["report"],"nullable":false,"type":"string"},"left":{"maximum":7,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":15,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":8,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":16,"minimum":1,"nullable":false,"type":"integer","format":"int32"}},"required":["type"]},{"type":"object","properties":{"type":{"enum":["report-portrait"],"nullable":false,"type":"string"},"left":{"maximum":5,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":15,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":6,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":16,"minimum":1,"nullable":false,"type":"integer","format":"int32"}},"required":["type"]},{"type":"object","properties":{"type":{"enum":["report-landscape"],"nullable":false,"type":"string"},"left":{"maximum":7,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":10,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":8,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":11,"minimum":1,"nullable":false,"type":"integer","format":"int32"}},"required":["type"]}]},"inputs":{"maxLength":16777215,"minLength":0,"nullable":false,"type":"string"}}}}}},"security":[{"bearerToken":[]}]},"delete":{"tags":["PageComponent"],"summary":"PageComponent","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/page-components":{"get":{"tags":["PageComponentList"],"summary":"PageComponentList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"pageVersion":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"template":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"boundVersion":{"nullable":true,"type":"object","properties":{"template":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"number":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"\\d+","type":"string"},"mainPath":{"maxLength":255,"minLength":4,"nullable":false,"type":"string"},"notes":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"publishedOn":{"nullable":true,"type":"string","format":"date-time"},"createdOn":{"nullable":false,"type":"string","format":"date-time"},"createdBy":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}},"dimensions":{"oneOf":[{"type":"object","properties":{"type":{"enum":["sheet"],"nullable":false,"type":"string"},"left":{"maximum":11,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":71,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":12,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":72,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"mobileHeight":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"mobileOrder":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"mobileLeft":{"maximum":11,"nullable":true,"type":"integer","format":"int32"},"mobileCols":{"maximum":12,"minimum":1,"nullable":true,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]},{"type":"object","properties":{"type":{"enum":["card"],"nullable":false,"type":"string"},"height":{"maximum":65535,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}},"required":["type","height","order"]},{"type":"object","properties":{"type":{"enum":["report"],"nullable":false,"type":"string"},"left":{"maximum":7,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":15,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":8,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":16,"minimum":1,"nullable":false,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]},{"type":"object","properties":{"type":{"enum":["report-portrait"],"nullable":false,"type":"string"},"left":{"maximum":5,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":15,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":6,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":16,"minimum":1,"nullable":false,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]},{"type":"object","properties":{"type":{"enum":["report-landscape"],"nullable":false,"type":"string"},"left":{"maximum":7,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":10,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":8,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":11,"minimum":1,"nullable":false,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]}]},"inputs":{"maxLength":16777215,"minLength":0,"nullable":false,"type":"string"},"pagePage":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"pageVersion":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"}],"security":[{"bearerToken":[]}]},"post":{"tags":["PageComponentList"],"summary":"PageComponentList","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"pageVersion":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"template":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"boundVersion":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"dimensions":{"oneOf":[{"type":"object","properties":{"type":{"enum":["sheet"],"nullable":false,"type":"string"},"left":{"maximum":11,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":71,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":12,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":72,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"mobileHeight":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"mobileOrder":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"mobileLeft":{"maximum":11,"nullable":true,"type":"integer","format":"int32"},"mobileCols":{"maximum":12,"minimum":1,"nullable":true,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]},{"type":"object","properties":{"type":{"enum":["card"],"nullable":false,"type":"string"},"height":{"maximum":65535,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}},"required":["type","height","order"]},{"type":"object","properties":{"type":{"enum":["report"],"nullable":false,"type":"string"},"left":{"maximum":7,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":15,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":8,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":16,"minimum":1,"nullable":false,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]},{"type":"object","properties":{"type":{"enum":["report-portrait"],"nullable":false,"type":"string"},"left":{"maximum":5,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":15,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":6,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":16,"minimum":1,"nullable":false,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]},{"type":"object","properties":{"type":{"enum":["report-landscape"],"nullable":false,"type":"string"},"left":{"maximum":7,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":10,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":8,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":11,"minimum":1,"nullable":false,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]}]},"inputs":{"maxLength":16777215,"minLength":0,"nullable":false,"type":"string"},"pagePage":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}},"required":["pageVersion","template","dimensions","inputs"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"patch":{"tags":["PageComponentList"],"summary":"PageComponentList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"boundVersion":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"dimensions":{"oneOf":[{"type":"object","properties":{"type":{"enum":["sheet"],"nullable":false,"type":"string"},"left":{"maximum":11,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":71,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":12,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":72,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"mobileHeight":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"mobileOrder":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"mobileLeft":{"maximum":11,"nullable":true,"type":"integer","format":"int32"},"mobileCols":{"maximum":12,"minimum":1,"nullable":true,"type":"integer","format":"int32"}},"required":["type"]},{"type":"object","properties":{"type":{"enum":["card"],"nullable":false,"type":"string"},"height":{"maximum":65535,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}},"required":["type"]},{"type":"object","properties":{"type":{"enum":["report"],"nullable":false,"type":"string"},"left":{"maximum":7,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":15,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":8,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":16,"minimum":1,"nullable":false,"type":"integer","format":"int32"}},"required":["type"]},{"type":"object","properties":{"type":{"enum":["report-portrait"],"nullable":false,"type":"string"},"left":{"maximum":5,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":15,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":6,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":16,"minimum":1,"nullable":false,"type":"integer","format":"int32"}},"required":["type"]},{"type":"object","properties":{"type":{"enum":["report-landscape"],"nullable":false,"type":"string"},"left":{"maximum":7,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":10,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":8,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":11,"minimum":1,"nullable":false,"type":"integer","format":"int32"}},"required":["type"]}]},"inputs":{"maxLength":16777215,"minLength":0,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"delete":{"tags":["PageComponentList"],"summary":"PageComponentList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/page-component-templates/{publicId}":{"get":{"tags":["PageComponentTemplate"],"summary":"PageComponentTemplate","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"company":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"version":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"author":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"licence":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"url":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"sheetSettings":{"nullable":true,"type":"object","properties":{"minCols":{"maximum":11,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"defaultCols":{"maximum":11,"minimum":1,"nullable":true,"type":"integer","format":"int32"},"maxCols":{"maximum":11,"minimum":1,"nullable":true,"type":"integer","format":"int32"},"minRows":{"maximum":11,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"defaultRows":{"maximum":11,"minimum":1,"nullable":true,"type":"integer","format":"int32"},"maxRows":{"maximum":11,"minimum":1,"nullable":true,"type":"integer","format":"int32"}}},"cardSettings":{"nullable":true,"type":"object","properties":{"minHeight":{"maximum":65535,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"defaultHeight":{"maximum":65535,"minimum":1,"nullable":true,"type":"integer","format":"int32"},"maxHeight":{"maximum":65535,"minimum":1,"nullable":true,"type":"integer","format":"int32"}}},"inputs":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"draft":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"published":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"category":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}}},"configuredVersion":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"number":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"\\d+","type":"string"},"mainPath":{"maxLength":255,"minLength":4,"nullable":false,"type":"string"}}},"backendComponent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"static":{"nullable":false,"type":"boolean"},"intent":{"type":"array","items":{"enum":["asset-configuration","landing-page","main-page"],"nullable":false,"type":"string"}},"private":{"nullable":false,"type":"boolean"}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"patch":{"tags":["PageComponentTemplate"],"summary":"PageComponentTemplate","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"backendComponent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"intent":{"type":"array","items":{"enum":["asset-configuration","landing-page","main-page"],"nullable":false,"type":"string"}}}}}}},"security":[{"bearerToken":[]}]}},"/page-component-template-categories":{"get":{"tags":["PageComponentTemplateCategoryList"],"summary":"PageComponentTemplateCategoryList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"}]}},"/page-component-template-configs/{publicId}":{"get":{"tags":["PageComponentTemplateConfig"],"summary":"PageComponentTemplateConfig","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"template":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"allowDraft":{"nullable":false,"type":"boolean"},"pinnedVersion":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/page-component-template-configs":{"get":{"tags":["PageComponentTemplateConfigList"],"summary":"PageComponentTemplateConfigList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"template":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"allowDraft":{"nullable":false,"type":"boolean"},"pinnedVersion":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"}],"security":[{"bearerToken":[]}]}},"/page-component-templates":{"get":{"tags":["PageComponentTemplateList"],"summary":"PageComponentTemplateList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"company":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"version":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"author":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"licence":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"url":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"sheetSettings":{"nullable":true,"type":"object","properties":{"minCols":{"maximum":11,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"defaultCols":{"maximum":11,"minimum":1,"nullable":true,"type":"integer","format":"int32"},"maxCols":{"maximum":11,"minimum":1,"nullable":true,"type":"integer","format":"int32"},"minRows":{"maximum":11,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"defaultRows":{"maximum":11,"minimum":1,"nullable":true,"type":"integer","format":"int32"},"maxRows":{"maximum":11,"minimum":1,"nullable":true,"type":"integer","format":"int32"}}},"cardSettings":{"nullable":true,"type":"object","properties":{"minHeight":{"maximum":65535,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"defaultHeight":{"maximum":65535,"minimum":1,"nullable":true,"type":"integer","format":"int32"},"maxHeight":{"maximum":65535,"minimum":1,"nullable":true,"type":"integer","format":"int32"}}},"inputs":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"draft":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"published":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"category":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}}},"configuredVersion":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"number":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"\\d+","type":"string"},"mainPath":{"maxLength":255,"minLength":4,"nullable":false,"type":"string"}}},"backendComponent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"static":{"nullable":false,"type":"boolean"},"intent":{"type":"array","items":{"enum":["asset-configuration","landing-page","main-page"],"nullable":false,"type":"string"}},"private":{"nullable":false,"type":"boolean"}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"}],"security":[{"bearerToken":[]}]},"post":{"tags":["PageComponentTemplateList"],"summary":"PageComponentTemplateList","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"backendComponent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"intent":{"type":"array","items":{"enum":["asset-configuration","landing-page","main-page"],"nullable":false,"type":"string"}}},"required":["name"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"patch":{"tags":["PageComponentTemplateList"],"summary":"PageComponentTemplateList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"backendComponent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"intent":{"type":"array","items":{"enum":["asset-configuration","landing-page","main-page"],"nullable":false,"type":"string"}}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/page-component-template-shares/{publicId}":{"get":{"tags":["PageComponentTemplateShare"],"summary":"PageComponentTemplateShare","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"company":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":24,"minLength":24,"nullable":false,"pattern":"(\\d{4}-){4}\\d{4}","type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"template":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/page-component-template-shares":{"get":{"tags":["PageComponentTemplateShareList"],"summary":"PageComponentTemplateShareList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"company":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":24,"minLength":24,"nullable":false,"pattern":"(\\d{4}-){4}\\d{4}","type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"template":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"}],"security":[{"bearerToken":[]}]},"post":{"tags":["PageComponentTemplateShareList"],"summary":"PageComponentTemplateShareList","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"company":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"template":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}},"required":["company","template"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/page-component-template-versions/{publicId}":{"get":{"tags":["PageComponentTemplateVersion"],"summary":"PageComponentTemplateVersion","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"template":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"number":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"\\d+","type":"string"},"mainPath":{"maxLength":255,"minLength":4,"nullable":false,"type":"string"},"notes":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"publishedOn":{"nullable":true,"type":"string","format":"date-time"},"createdOn":{"nullable":false,"type":"string","format":"date-time"},"createdBy":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"patch":{"tags":["PageComponentTemplateVersion"],"summary":"PageComponentTemplateVersion","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"notes":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"published":{"nullable":false,"type":"boolean"}}}}}},"security":[{"bearerToken":[]}]}},"/page-component-template-versions":{"get":{"tags":["PageComponentTemplateVersionList"],"summary":"PageComponentTemplateVersionList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"template":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"number":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"\\d+","type":"string"},"mainPath":{"maxLength":255,"minLength":4,"nullable":false,"type":"string"},"notes":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"publishedOn":{"nullable":true,"type":"string","format":"date-time"},"createdOn":{"nullable":false,"type":"string","format":"date-time"},"createdBy":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"}],"security":[{"bearerToken":[]}]},"patch":{"tags":["PageComponentTemplateVersionList"],"summary":"PageComponentTemplateVersionList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"notes":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"published":{"nullable":false,"type":"boolean"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/page-component-templates/{publicId}/version-upload":{"post":{"tags":["PageComponentTemplateVersionUpload"],"summary":"PageComponentTemplateVersionUpload","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/zip":{"schema":{"type":"string","format":"binary"}}},"description":"This endpoint requires a zip file upload"},"security":[{"bearerToken":[]}]}},"/pages/{publicId}/default":{"post":{"tags":["PageDefault"],"summary":"PageDefault","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"delete":{"tags":["PageDefault"],"summary":"PageDefault","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/pages/{publicId}/draft":{"post":{"tags":["PageDraft"],"summary":"PageDraft","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/pages/draft":{"post":{"tags":["PageDraftList"],"summary":"PageDraftList","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/pages/{publicId}/duplicate":{"post":{"tags":["PageDuplicate"],"summary":"PageDuplicate","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"applicationType":{"enum":["sheet","card","report"],"nullable":false,"type":"string"},"company":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"group":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"draft":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"page":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"title":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"components":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"pageVersion":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"template":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"boundVersion":{"nullable":true,"type":"object","properties":{"template":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"number":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"\\d+","type":"string"},"mainPath":{"maxLength":255,"minLength":4,"nullable":false,"type":"string"},"notes":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"publishedOn":{"nullable":true,"type":"string","format":"date-time"},"createdOn":{"nullable":false,"type":"string","format":"date-time"},"createdBy":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}},"dimensions":{"oneOf":[{"type":"object","properties":{"type":{"enum":["sheet"],"nullable":false,"type":"string"},"left":{"maximum":11,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":71,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":12,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":72,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"mobileHeight":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"mobileOrder":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"mobileLeft":{"maximum":11,"nullable":true,"type":"integer","format":"int32"},"mobileCols":{"maximum":12,"minimum":1,"nullable":true,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]},{"type":"object","properties":{"type":{"enum":["card"],"nullable":false,"type":"string"},"height":{"maximum":65535,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}},"required":["type","height","order"]},{"type":"object","properties":{"type":{"enum":["report"],"nullable":false,"type":"string"},"left":{"maximum":7,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":15,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":8,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":16,"minimum":1,"nullable":false,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]},{"type":"object","properties":{"type":{"enum":["report-portrait"],"nullable":false,"type":"string"},"left":{"maximum":5,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":15,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":6,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":16,"minimum":1,"nullable":false,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]},{"type":"object","properties":{"type":{"enum":["report-landscape"],"nullable":false,"type":"string"},"left":{"maximum":7,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":10,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":8,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":11,"minimum":1,"nullable":false,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]}]},"inputs":{"maxLength":16777215,"minLength":0,"nullable":false,"type":"string"},"pagePage":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"pageVersion":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}}}}}},"previewAgent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"previewAsset":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"periodSpec":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"periodSelectorEnabled":{"nullable":false,"type":"boolean"},"defaultRefreshRate":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"createdOn":{"nullable":false,"type":"string","format":"date-time"},"createdBy":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"updatedOn":{"nullable":true,"type":"string","format":"date-time"},"updatedBy":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"pagePages":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"pageVersion":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}}}},"custom":{"nullable":false,"type":"object"}}},"published":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"page":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"title":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"components":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"pageVersion":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"template":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"boundVersion":{"nullable":true,"type":"object","properties":{"template":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"number":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"\\d+","type":"string"},"mainPath":{"maxLength":255,"minLength":4,"nullable":false,"type":"string"},"notes":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"publishedOn":{"nullable":true,"type":"string","format":"date-time"},"createdOn":{"nullable":false,"type":"string","format":"date-time"},"createdBy":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}},"dimensions":{"oneOf":[{"type":"object","properties":{"type":{"enum":["sheet"],"nullable":false,"type":"string"},"left":{"maximum":11,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":71,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":12,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":72,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"mobileHeight":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"mobileOrder":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"mobileLeft":{"maximum":11,"nullable":true,"type":"integer","format":"int32"},"mobileCols":{"maximum":12,"minimum":1,"nullable":true,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]},{"type":"object","properties":{"type":{"enum":["card"],"nullable":false,"type":"string"},"height":{"maximum":65535,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}},"required":["type","height","order"]},{"type":"object","properties":{"type":{"enum":["report"],"nullable":false,"type":"string"},"left":{"maximum":7,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":15,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":8,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":16,"minimum":1,"nullable":false,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]},{"type":"object","properties":{"type":{"enum":["report-portrait"],"nullable":false,"type":"string"},"left":{"maximum":5,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":15,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":6,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":16,"minimum":1,"nullable":false,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]},{"type":"object","properties":{"type":{"enum":["report-landscape"],"nullable":false,"type":"string"},"left":{"maximum":7,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":10,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":8,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":11,"minimum":1,"nullable":false,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]}]},"inputs":{"maxLength":16777215,"minLength":0,"nullable":false,"type":"string"},"pagePage":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"pageVersion":{"nullable":false,"type":"object"},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}}}}}},"previewAgent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"previewAsset":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"periodSpec":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"periodSelectorEnabled":{"nullable":false,"type":"boolean"},"defaultRefreshRate":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"createdOn":{"nullable":false,"type":"string","format":"date-time"},"createdBy":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"updatedOn":{"nullable":true,"type":"string","format":"date-time"},"updatedBy":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"pagePages":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"pageVersion":{"nullable":false,"type":"object"},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}}}},"custom":{"nullable":false,"type":"object"}}},"default":{"nullable":false,"type":"boolean"},"static":{"nullable":false,"type":"boolean"},"orientation":{"enum":["portrait","landscape"],"nullable":true,"type":"string"},"labels":{"type":"array","items":{"nullable":false,"type":"object","properties":{"color":{"maxLength":7,"minLength":6,"nullable":false,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"company":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}},"custom":{"nullable":false,"type":"object"}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/pages/duplicate":{"post":{"tags":["PageDuplicateList"],"summary":"PageDuplicateList","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"applicationType":{"enum":["sheet","card","report"],"nullable":false,"type":"string"},"company":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"group":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"draft":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"page":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"title":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"components":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"pageVersion":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"template":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"boundVersion":{"nullable":true,"type":"object","properties":{"template":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"number":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"\\d+","type":"string"},"mainPath":{"maxLength":255,"minLength":4,"nullable":false,"type":"string"},"notes":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"publishedOn":{"nullable":true,"type":"string","format":"date-time"},"createdOn":{"nullable":false,"type":"string","format":"date-time"},"createdBy":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}},"dimensions":{"oneOf":[{"type":"object","properties":{"type":{"enum":["sheet"],"nullable":false,"type":"string"},"left":{"maximum":11,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":71,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":12,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":72,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"mobileHeight":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"mobileOrder":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"mobileLeft":{"maximum":11,"nullable":true,"type":"integer","format":"int32"},"mobileCols":{"maximum":12,"minimum":1,"nullable":true,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]},{"type":"object","properties":{"type":{"enum":["card"],"nullable":false,"type":"string"},"height":{"maximum":65535,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}},"required":["type","height","order"]},{"type":"object","properties":{"type":{"enum":["report"],"nullable":false,"type":"string"},"left":{"maximum":7,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":15,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":8,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":16,"minimum":1,"nullable":false,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]},{"type":"object","properties":{"type":{"enum":["report-portrait"],"nullable":false,"type":"string"},"left":{"maximum":5,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":15,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":6,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":16,"minimum":1,"nullable":false,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]},{"type":"object","properties":{"type":{"enum":["report-landscape"],"nullable":false,"type":"string"},"left":{"maximum":7,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":10,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":8,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":11,"minimum":1,"nullable":false,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]}]},"inputs":{"maxLength":16777215,"minLength":0,"nullable":false,"type":"string"},"pagePage":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"pageVersion":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}}}}}},"previewAgent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"previewAsset":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"periodSpec":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"periodSelectorEnabled":{"nullable":false,"type":"boolean"},"defaultRefreshRate":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"createdOn":{"nullable":false,"type":"string","format":"date-time"},"createdBy":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"updatedOn":{"nullable":true,"type":"string","format":"date-time"},"updatedBy":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"pagePages":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"pageVersion":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}}}},"custom":{"nullable":false,"type":"object"}}},"published":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"page":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"title":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"components":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"pageVersion":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"template":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"boundVersion":{"nullable":true,"type":"object","properties":{"template":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"number":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"\\d+","type":"string"},"mainPath":{"maxLength":255,"minLength":4,"nullable":false,"type":"string"},"notes":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"publishedOn":{"nullable":true,"type":"string","format":"date-time"},"createdOn":{"nullable":false,"type":"string","format":"date-time"},"createdBy":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}},"dimensions":{"oneOf":[{"type":"object","properties":{"type":{"enum":["sheet"],"nullable":false,"type":"string"},"left":{"maximum":11,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":71,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":12,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":72,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"mobileHeight":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"mobileOrder":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"mobileLeft":{"maximum":11,"nullable":true,"type":"integer","format":"int32"},"mobileCols":{"maximum":12,"minimum":1,"nullable":true,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]},{"type":"object","properties":{"type":{"enum":["card"],"nullable":false,"type":"string"},"height":{"maximum":65535,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}},"required":["type","height","order"]},{"type":"object","properties":{"type":{"enum":["report"],"nullable":false,"type":"string"},"left":{"maximum":7,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":15,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":8,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":16,"minimum":1,"nullable":false,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]},{"type":"object","properties":{"type":{"enum":["report-portrait"],"nullable":false,"type":"string"},"left":{"maximum":5,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":15,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":6,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":16,"minimum":1,"nullable":false,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]},{"type":"object","properties":{"type":{"enum":["report-landscape"],"nullable":false,"type":"string"},"left":{"maximum":7,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":10,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":8,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":11,"minimum":1,"nullable":false,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]}]},"inputs":{"maxLength":16777215,"minLength":0,"nullable":false,"type":"string"},"pagePage":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"pageVersion":{"nullable":false,"type":"object"},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}}}}}},"previewAgent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"previewAsset":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"periodSpec":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"periodSelectorEnabled":{"nullable":false,"type":"boolean"},"defaultRefreshRate":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"createdOn":{"nullable":false,"type":"string","format":"date-time"},"createdBy":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"updatedOn":{"nullable":true,"type":"string","format":"date-time"},"updatedBy":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"pagePages":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"pageVersion":{"nullable":false,"type":"object"},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}}}},"custom":{"nullable":false,"type":"object"}}},"default":{"nullable":false,"type":"boolean"},"static":{"nullable":false,"type":"boolean"},"orientation":{"enum":["portrait","landscape"],"nullable":true,"type":"string"},"labels":{"type":"array","items":{"nullable":false,"type":"object","properties":{"color":{"maxLength":7,"minLength":6,"nullable":false,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"company":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}},"custom":{"nullable":false,"type":"object"}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/pages/{publicId}/export":{"get":{"tags":["PageExport"],"summary":"PageExport","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/page-import":{"post":{"tags":["PageImport"],"summary":"PageImport","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"string","format":"binary"}}},"description":"This endpoint requires a JSON file upload"},"security":[{"bearerToken":[]}]}},"/pages":{"get":{"tags":["PageList"],"summary":"PageList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"applicationType":{"enum":["sheet","card","report"],"nullable":false,"type":"string"},"company":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"group":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"draft":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"page":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"title":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"components":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"pageVersion":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"template":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"boundVersion":{"nullable":true,"type":"object","properties":{"template":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"number":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"\\d+","type":"string"},"mainPath":{"maxLength":255,"minLength":4,"nullable":false,"type":"string"},"notes":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"publishedOn":{"nullable":true,"type":"string","format":"date-time"},"createdOn":{"nullable":false,"type":"string","format":"date-time"},"createdBy":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}},"dimensions":{"oneOf":[{"type":"object","properties":{"type":{"enum":["sheet"],"nullable":false,"type":"string"},"left":{"maximum":11,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":71,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":12,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":72,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"mobileHeight":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"mobileOrder":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"mobileLeft":{"maximum":11,"nullable":true,"type":"integer","format":"int32"},"mobileCols":{"maximum":12,"minimum":1,"nullable":true,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]},{"type":"object","properties":{"type":{"enum":["card"],"nullable":false,"type":"string"},"height":{"maximum":65535,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}},"required":["type","height","order"]},{"type":"object","properties":{"type":{"enum":["report"],"nullable":false,"type":"string"},"left":{"maximum":7,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":15,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":8,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":16,"minimum":1,"nullable":false,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]},{"type":"object","properties":{"type":{"enum":["report-portrait"],"nullable":false,"type":"string"},"left":{"maximum":5,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":15,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":6,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":16,"minimum":1,"nullable":false,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]},{"type":"object","properties":{"type":{"enum":["report-landscape"],"nullable":false,"type":"string"},"left":{"maximum":7,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":10,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":8,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":11,"minimum":1,"nullable":false,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]}]},"inputs":{"maxLength":16777215,"minLength":0,"nullable":false,"type":"string"},"pagePage":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"pageVersion":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}}}}}},"previewAgent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"previewAsset":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"periodSpec":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"periodSelectorEnabled":{"nullable":false,"type":"boolean"},"defaultRefreshRate":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"createdOn":{"nullable":false,"type":"string","format":"date-time"},"createdBy":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"updatedOn":{"nullable":true,"type":"string","format":"date-time"},"updatedBy":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"pagePages":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"pageVersion":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}}}},"custom":{"nullable":false,"type":"object"}}},"published":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"page":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"title":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"components":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"pageVersion":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"template":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"boundVersion":{"nullable":true,"type":"object","properties":{"template":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"number":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"\\d+","type":"string"},"mainPath":{"maxLength":255,"minLength":4,"nullable":false,"type":"string"},"notes":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"publishedOn":{"nullable":true,"type":"string","format":"date-time"},"createdOn":{"nullable":false,"type":"string","format":"date-time"},"createdBy":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}},"dimensions":{"oneOf":[{"type":"object","properties":{"type":{"enum":["sheet"],"nullable":false,"type":"string"},"left":{"maximum":11,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":71,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":12,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":72,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"mobileHeight":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"mobileOrder":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"mobileLeft":{"maximum":11,"nullable":true,"type":"integer","format":"int32"},"mobileCols":{"maximum":12,"minimum":1,"nullable":true,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]},{"type":"object","properties":{"type":{"enum":["card"],"nullable":false,"type":"string"},"height":{"maximum":65535,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}},"required":["type","height","order"]},{"type":"object","properties":{"type":{"enum":["report"],"nullable":false,"type":"string"},"left":{"maximum":7,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":15,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":8,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":16,"minimum":1,"nullable":false,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]},{"type":"object","properties":{"type":{"enum":["report-portrait"],"nullable":false,"type":"string"},"left":{"maximum":5,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":15,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":6,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":16,"minimum":1,"nullable":false,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]},{"type":"object","properties":{"type":{"enum":["report-landscape"],"nullable":false,"type":"string"},"left":{"maximum":7,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":10,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":8,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":11,"minimum":1,"nullable":false,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]}]},"inputs":{"maxLength":16777215,"minLength":0,"nullable":false,"type":"string"},"pagePage":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"pageVersion":{"nullable":false,"type":"object"},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}}}}}},"previewAgent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"previewAsset":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"periodSpec":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"periodSelectorEnabled":{"nullable":false,"type":"boolean"},"defaultRefreshRate":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"createdOn":{"nullable":false,"type":"string","format":"date-time"},"createdBy":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"updatedOn":{"nullable":true,"type":"string","format":"date-time"},"updatedBy":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"pagePages":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"pageVersion":{"nullable":false,"type":"object"},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}}}},"custom":{"nullable":false,"type":"object"}}},"default":{"nullable":false,"type":"boolean"},"static":{"nullable":false,"type":"boolean"},"orientation":{"enum":["portrait","landscape"],"nullable":true,"type":"string"},"labels":{"type":"array","items":{"nullable":false,"type":"object","properties":{"color":{"maxLength":7,"minLength":6,"nullable":false,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"company":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}},"custom":{"nullable":false,"type":"object"}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"}],"security":[{"bearerToken":[]}]},"post":{"tags":["PageList"],"summary":"PageList","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"applicationType":{"enum":["sheet","card","report"],"nullable":false,"type":"string"},"group":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"static":{"nullable":false,"type":"boolean"},"orientation":{"enum":["portrait","landscape"],"nullable":true,"type":"string"},"labels":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}},"custom":{"nullable":false,"type":"object"}},"required":["name"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"patch":{"tags":["PageList"],"summary":"PageList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"draft":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"published":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"static":{"nullable":false,"type":"boolean"},"group":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"labels":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}},"custom":{"nullable":false,"type":"object"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"delete":{"tags":["PageList"],"summary":"PageList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/pages-pages/{publicId}":{"get":{"tags":["PagePage"],"summary":"PagePage","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"pageVersion":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"delete":{"tags":["PagePage"],"summary":"PagePage","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/pages-pages":{"get":{"tags":["PagePageList"],"summary":"PagePageList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"pageVersion":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"}],"security":[{"bearerToken":[]}]},"post":{"tags":["PagePageList"],"summary":"PagePageList","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"pageVersion":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}},"required":["pageVersion"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"delete":{"tags":["PagePageList"],"summary":"PagePageList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/page-versions/{publicId}":{"get":{"tags":["PageVersion"],"summary":"PageVersion","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"page":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"title":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"components":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"pageVersion":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"template":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"boundVersion":{"nullable":true,"type":"object","properties":{"template":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"number":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"\\d+","type":"string"},"mainPath":{"maxLength":255,"minLength":4,"nullable":false,"type":"string"},"notes":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"publishedOn":{"nullable":true,"type":"string","format":"date-time"},"createdOn":{"nullable":false,"type":"string","format":"date-time"},"createdBy":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}},"dimensions":{"oneOf":[{"type":"object","properties":{"type":{"enum":["sheet"],"nullable":false,"type":"string"},"left":{"maximum":11,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":71,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":12,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":72,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"mobileHeight":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"mobileOrder":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"mobileLeft":{"maximum":11,"nullable":true,"type":"integer","format":"int32"},"mobileCols":{"maximum":12,"minimum":1,"nullable":true,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]},{"type":"object","properties":{"type":{"enum":["card"],"nullable":false,"type":"string"},"height":{"maximum":65535,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}},"required":["type","height","order"]},{"type":"object","properties":{"type":{"enum":["report"],"nullable":false,"type":"string"},"left":{"maximum":7,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":15,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":8,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":16,"minimum":1,"nullable":false,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]},{"type":"object","properties":{"type":{"enum":["report-portrait"],"nullable":false,"type":"string"},"left":{"maximum":5,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":15,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":6,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":16,"minimum":1,"nullable":false,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]},{"type":"object","properties":{"type":{"enum":["report-landscape"],"nullable":false,"type":"string"},"left":{"maximum":7,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":10,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":8,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":11,"minimum":1,"nullable":false,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]}]},"inputs":{"maxLength":16777215,"minLength":0,"nullable":false,"type":"string"},"pagePage":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"pageVersion":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}}}}}},"previewAgent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"previewAsset":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"periodSpec":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"periodSelectorEnabled":{"nullable":false,"type":"boolean"},"defaultRefreshRate":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"createdOn":{"nullable":false,"type":"string","format":"date-time"},"createdBy":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"updatedOn":{"nullable":true,"type":"string","format":"date-time"},"updatedBy":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"pagePages":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"pageVersion":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}}}},"custom":{"nullable":false,"type":"object"}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"patch":{"tags":["PageVersion"],"summary":"PageVersion","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"previewAgent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"previewAsset":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"periodSpec":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"periodSelectorEnabled":{"nullable":false,"type":"boolean"},"defaultRefreshRate":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"custom":{"nullable":false,"type":"object"}}}}}},"security":[{"bearerToken":[]}]},"delete":{"tags":["PageVersion"],"summary":"PageVersion","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/page-versions":{"get":{"tags":["PageVersionList"],"summary":"PageVersionList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"page":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"title":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"components":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"pageVersion":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"template":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"boundVersion":{"nullable":true,"type":"object","properties":{"template":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"number":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"\\d+","type":"string"},"mainPath":{"maxLength":255,"minLength":4,"nullable":false,"type":"string"},"notes":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"publishedOn":{"nullable":true,"type":"string","format":"date-time"},"createdOn":{"nullable":false,"type":"string","format":"date-time"},"createdBy":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}},"dimensions":{"oneOf":[{"type":"object","properties":{"type":{"enum":["sheet"],"nullable":false,"type":"string"},"left":{"maximum":11,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":71,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":12,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":72,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"mobileHeight":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"mobileOrder":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"mobileLeft":{"maximum":11,"nullable":true,"type":"integer","format":"int32"},"mobileCols":{"maximum":12,"minimum":1,"nullable":true,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]},{"type":"object","properties":{"type":{"enum":["card"],"nullable":false,"type":"string"},"height":{"maximum":65535,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}},"required":["type","height","order"]},{"type":"object","properties":{"type":{"enum":["report"],"nullable":false,"type":"string"},"left":{"maximum":7,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":15,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":8,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":16,"minimum":1,"nullable":false,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]},{"type":"object","properties":{"type":{"enum":["report-portrait"],"nullable":false,"type":"string"},"left":{"maximum":5,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":15,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":6,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":16,"minimum":1,"nullable":false,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]},{"type":"object","properties":{"type":{"enum":["report-landscape"],"nullable":false,"type":"string"},"left":{"maximum":7,"nullable":false,"type":"integer","format":"int32"},"top":{"maximum":10,"nullable":false,"type":"integer","format":"int32"},"cols":{"maximum":8,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"rows":{"maximum":11,"minimum":1,"nullable":false,"type":"integer","format":"int32"}},"required":["type","left","top","cols","rows"]}]},"inputs":{"maxLength":16777215,"minLength":0,"nullable":false,"type":"string"},"pagePage":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"pageVersion":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}}}}}},"previewAgent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"previewAsset":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"periodSpec":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"periodSelectorEnabled":{"nullable":false,"type":"boolean"},"defaultRefreshRate":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"createdOn":{"nullable":false,"type":"string","format":"date-time"},"createdBy":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"updatedOn":{"nullable":true,"type":"string","format":"date-time"},"updatedBy":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"pagePages":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"pageVersion":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}}}},"custom":{"nullable":false,"type":"object"}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"}],"security":[{"bearerToken":[]}]},"post":{"tags":["PageVersionList"],"summary":"PageVersionList","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"page":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"title":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"previewAgent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"previewAsset":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"periodSpec":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"periodSelectorEnabled":{"nullable":false,"type":"boolean"},"defaultRefreshRate":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"custom":{"nullable":false,"type":"object"}},"required":["page"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"patch":{"tags":["PageVersionList"],"summary":"PageVersionList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"title":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"previewAgent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"previewAsset":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"periodSpec":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"periodSelectorEnabled":{"nullable":false,"type":"boolean"},"defaultRefreshRate":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"custom":{"nullable":false,"type":"object"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"delete":{"tags":["PageVersionList"],"summary":"PageVersionList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/permissions":{"get":{"tags":["PermissionList"],"summary":"PermissionList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"custom":{"nullable":false,"type":"object"}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"}]}},"/pipeline-functions":{"get":{"tags":["PipelineFunctionList"],"summary":"PipelineFunctionList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"company":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":24,"minLength":24,"nullable":false,"pattern":"(\\d{4}-){4}\\d{4}","type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"}],"security":[{"bearerToken":[]}]},"post":{"tags":["PipelineFunctionList"],"summary":"PipelineFunctionList","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"}},"required":["name"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/platform-servers":{"get":{"tags":["PlatformServerList"],"summary":"PlatformServerList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"type":{"maxLength":3,"minLength":3,"nullable":false,"type":"string"},"location":{"nullable":false,"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"latitude":{"nullable":false,"type":"string"},"longitude":{"nullable":false,"type":"string"}}},"vpnRange":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"}]}},"/premium/domain":{"post":{"tags":["PremiumDomain"],"summary":"PremiumDomain","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"customFqdn":{"maxLength":253,"minLength":4,"nullable":false,"pattern":".+(\\..[^.]+)","type":"string"},"validateOnly":{"nullable":false,"type":"boolean"}},"required":["customFqdn"]}}}},"security":[{"bearerToken":[]}]}},"/privacy-statements/{publicId}":{"get":{"tags":["PrivacyStatement"],"summary":"PrivacyStatement","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"company":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"latest":{"nullable":true,"type":"boolean"},"version":{"maxLength":5,"minLength":1,"nullable":true,"type":"string"},"publishedOn":{"nullable":true,"type":"string","format":"date-time"},"downloadUrl":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"type":{"enum":["termsofuse","privacystatement"],"nullable":false,"type":"string"},"languages":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"languageCode":{"maxLength":2,"minLength":2,"nullable":false,"type":"string"},"body":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"updateSummary":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"policy":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}]}},"/privacy-statements/{publicId}/download":{"get":{"tags":["PrivacyStatementDownload"],"summary":"PrivacyStatementDownload","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}]}},"/privacy-statements":{"get":{"tags":["PrivacyStatementList"],"summary":"PrivacyStatementList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"company":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"latest":{"nullable":true,"type":"boolean"},"version":{"maxLength":5,"minLength":1,"nullable":true,"type":"string"},"publishedOn":{"nullable":true,"type":"string","format":"date-time"},"downloadUrl":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"type":{"enum":["termsofuse","privacystatement"],"nullable":false,"type":"string"},"languages":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"languageCode":{"maxLength":2,"minLength":2,"nullable":false,"type":"string"},"body":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"updateSummary":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"policy":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"}]}},"/public-files/upload":{"post":{"tags":["PublicFileUpload"],"summary":"PublicFileUpload","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"company":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"type":{"enum":["image"],"nullable":false,"type":"string"},"url":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"size":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"image/*":{"schema":{"type":"string","format":"binary"}}},"description":"This endpoint requires a file upload"},"security":[{"bearerToken":[]}]}},"/pages/report/queue":{"post":{"tags":["QueueReportList"],"summary":"QueueReportList","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"asset":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"report":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"timeZone":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"start":{"nullable":false,"type":"string","format":"date-time"},"end":{"nullable":false,"type":"string","format":"date-time"}},"required":["report","timeZone","start","end"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/registrations":{"post":{"tags":["RegistrationList"],"summary":"RegistrationList","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingRequired"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"companyName":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"language":{"maxLength":2,"minLength":2,"nullable":false,"type":"string"},"localisation":{"maxLength":10,"minLength":1,"nullable":false,"type":"string"},"timeZone":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"termsOfUsePolicy":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"emailAddress":{"maxLength":254,"minLength":6,"nullable":false,"pattern":"^(?=.{1,254}$)(?=.{1,64}@)[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+(?:\\.[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+)*@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$","type":"string"},"password":{"minLength":8,"nullable":false,"type":"string"}},"required":["companyName","name","emailAddress","password"]}}}}}},"/roles/{publicId}":{"get":{"tags":["Role"],"summary":"Role","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"enforce2fa":{"nullable":false,"type":"boolean"},"enforceSso":{"nullable":false,"type":"boolean"},"permissions":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"custom":{"nullable":false,"type":"object"}}}},"audiences":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"custom":{"nullable":false,"type":"object"},"default":{"nullable":false,"type":"boolean"},"type":{"enum":["alarm","page","service"],"nullable":true,"type":"string"}}}},"custom":{"nullable":false,"type":"object"}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"patch":{"tags":["Role"],"summary":"Role","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"enforce2fa":{"nullable":false,"type":"boolean"},"enforceSso":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"}}}}}},"security":[{"bearerToken":[]}]},"delete":{"tags":["Role"],"summary":"Role","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/roles/{parentId}/audiences/{publicId}":{"delete":{"tags":["RoleAudience"],"summary":"RoleAudience","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"parentId","in":"path","schema":{"type":"string"}},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/roles/{publicId}/audiences":{"post":{"tags":["RoleAudienceList"],"summary":"RoleAudienceList","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"put":{"tags":["RoleAudienceList"],"summary":"RoleAudienceList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"delete":{"tags":["RoleAudienceList"],"summary":"RoleAudienceList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/roles":{"get":{"tags":["RoleList"],"summary":"RoleList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"enforce2fa":{"nullable":false,"type":"boolean"},"enforceSso":{"nullable":false,"type":"boolean"},"permissions":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"custom":{"nullable":false,"type":"object"}}}},"audiences":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"custom":{"nullable":false,"type":"object"},"default":{"nullable":false,"type":"boolean"},"type":{"enum":["alarm","page","service"],"nullable":true,"type":"string"}}}},"custom":{"nullable":false,"type":"object"}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"}],"security":[{"bearerToken":[]}]},"patch":{"tags":["RoleList"],"summary":"RoleList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"enforce2fa":{"nullable":false,"type":"boolean"},"enforceSso":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"post":{"tags":["RoleList"],"summary":"RoleList","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"enforce2fa":{"nullable":false,"type":"boolean"},"enforceSso":{"nullable":false,"type":"boolean"},"permissions":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}},"audiences":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}},"custom":{"nullable":false,"type":"object"}},"required":["name"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"delete":{"tags":["RoleList"],"summary":"RoleList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/roles/{parentId}/permissions/{publicId}":{"delete":{"tags":["RolePermission"],"summary":"RolePermission","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"parentId","in":"path","schema":{"type":"string"}},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/roles/{publicId}/permissions":{"post":{"tags":["RolePermissionList"],"summary":"RolePermissionList","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"put":{"tags":["RolePermissionList"],"summary":"RolePermissionList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"delete":{"tags":["RolePermissionList"],"summary":"RolePermissionList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/router-display-screensaver/{publicId}":{"get":{"tags":["RouterDisplayScreensaver"],"summary":"RouterDisplayScreensaver","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"delete":{"tags":["RouterDisplayScreensaver"],"summary":"RouterDisplayScreensaver","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/router-display-screensaver/upload":{"post":{"tags":["RouterDisplayScreensaverUpload"],"summary":"RouterDisplayScreensaverUpload","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"image/*":{"schema":{"type":"string","format":"binary"}}},"description":"This endpoint requires a file upload"},"security":[{"bearerToken":[]}]}},"/{api-version}/{api-application}/scim/v2/Schemas":{"get":{"tags":["ScimSchemas"],"summary":"ScimSchemas","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"api-version","in":"path","schema":{"type":"string"}},{"required":true,"name":"api-application","in":"path","schema":{"type":"string"}}]}},"/{api-version}/{api-application}/scim/v2/ServiceProviderConfig":{"get":{"tags":["ScimServiceProviderConfig"],"summary":"ScimServiceProviderConfig","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"api-version","in":"path","schema":{"type":"string"}},{"required":true,"name":"api-application","in":"path","schema":{"type":"string"}}]}},"/sectors/{publicId}":{"get":{"tags":["Sector"],"summary":"Sector","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"corporateWebsite":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"defaultCountry":{"maxLength":2,"minLength":2,"nullable":false,"type":"string"},"custom":{"nullable":false,"type":"object"},"emailFromAddress":{"maxLength":320,"minLength":1,"nullable":false,"type":"string"},"feedbackTo":{"maxLength":320,"minLength":1,"nullable":true,"type":"string"},"supportEmailAddress":{"maxLength":320,"minLength":1,"nullable":true,"type":"string"},"allowCustomTermsOfUse":{"nullable":false,"type":"boolean"},"allowCustomPrivacyStatement":{"nullable":false,"type":"boolean"},"latestTermsOfUse":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"company":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"latest":{"nullable":true,"type":"boolean"},"version":{"maxLength":5,"minLength":1,"nullable":true,"type":"string"},"publishedOn":{"nullable":true,"type":"string","format":"date-time"},"downloadUrl":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"type":{"enum":["termsofuse","privacystatement"],"nullable":false,"type":"string"},"languages":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"languageCode":{"maxLength":2,"minLength":2,"nullable":false,"type":"string"},"body":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"updateSummary":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"policy":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}}}},"latestPrivacyStatement":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"company":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"latest":{"nullable":true,"type":"boolean"},"version":{"maxLength":5,"minLength":1,"nullable":true,"type":"string"},"publishedOn":{"nullable":true,"type":"string","format":"date-time"},"downloadUrl":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"type":{"enum":["termsofuse","privacystatement"],"nullable":false,"type":"string"},"languages":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"languageCode":{"maxLength":2,"minLength":2,"nullable":false,"type":"string"},"body":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"updateSummary":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"policy":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}}}},"branding":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"fqdn":{"maxLength":253,"minLength":4,"nullable":true,"pattern":".+(\\..[^.]+)","type":"string"},"theme":{"nullable":true,"type":"object","properties":{"primaryColor":{"maxLength":7,"minLength":6,"nullable":false,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"primaryTextColor":{"maxLength":7,"minLength":6,"nullable":false,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"accentColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"accentTextColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"headerColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"headerLineColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"menuColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"menuTextColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"pageColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"pageTextColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"cardColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"cardTextColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"logoHasBackgroundColor":{"nullable":false,"type":"boolean"},"logoOnHeaderColorSpec":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"}}},"appleTouchIcon":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"favicon":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"logo":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"logoDark":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"appleAppStoreLink":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"googlePlayStoreLink":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"landingPageComponentTemplate":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"company":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"version":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"author":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"licence":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"url":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"sheetSettings":{"nullable":true,"type":"object","properties":{"minCols":{"maximum":11,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"defaultCols":{"maximum":11,"minimum":1,"nullable":true,"type":"integer","format":"int32"},"maxCols":{"maximum":11,"minimum":1,"nullable":true,"type":"integer","format":"int32"},"minRows":{"maximum":11,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"defaultRows":{"maximum":11,"minimum":1,"nullable":true,"type":"integer","format":"int32"},"maxRows":{"maximum":11,"minimum":1,"nullable":true,"type":"integer","format":"int32"}}},"cardSettings":{"nullable":true,"type":"object","properties":{"minHeight":{"maximum":65535,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"defaultHeight":{"maximum":65535,"minimum":1,"nullable":true,"type":"integer","format":"int32"},"maxHeight":{"maximum":65535,"minimum":1,"nullable":true,"type":"integer","format":"int32"}}},"inputs":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"draft":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"published":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"category":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}}},"configuredVersion":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"number":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"\\d+","type":"string"},"mainPath":{"maxLength":255,"minLength":4,"nullable":false,"type":"string"}}},"backendComponent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"static":{"nullable":false,"type":"boolean"},"intent":{"type":"array","items":{"enum":["asset-configuration","landing-page","main-page"],"nullable":false,"type":"string"}},"private":{"nullable":false,"type":"boolean"}}},"custom":{"nullable":false,"type":"object"}}},"premiumBrandingDomain":{"maxLength":253,"minLength":4,"nullable":true,"pattern":".+(\\..[^.]+)","type":"string"},"cdnDomain":{"maxLength":253,"minLength":4,"nullable":true,"pattern":".+(\\..[^.]+)","type":"string"},"poweredBy":{"nullable":true,"type":"object","properties":{"hide":{"nullable":false,"type":"boolean"},"logo":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"name":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"url":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}]}},"/sectors":{"get":{"tags":["SectorList"],"summary":"SectorList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"corporateWebsite":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"defaultCountry":{"maxLength":2,"minLength":2,"nullable":false,"type":"string"},"custom":{"nullable":false,"type":"object"},"emailFromAddress":{"maxLength":320,"minLength":1,"nullable":false,"type":"string"},"feedbackTo":{"maxLength":320,"minLength":1,"nullable":true,"type":"string"},"supportEmailAddress":{"maxLength":320,"minLength":1,"nullable":true,"type":"string"},"allowCustomTermsOfUse":{"nullable":false,"type":"boolean"},"allowCustomPrivacyStatement":{"nullable":false,"type":"boolean"},"latestTermsOfUse":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"company":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"latest":{"nullable":true,"type":"boolean"},"version":{"maxLength":5,"minLength":1,"nullable":true,"type":"string"},"publishedOn":{"nullable":true,"type":"string","format":"date-time"},"downloadUrl":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"type":{"enum":["termsofuse","privacystatement"],"nullable":false,"type":"string"},"languages":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"languageCode":{"maxLength":2,"minLength":2,"nullable":false,"type":"string"},"body":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"updateSummary":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"policy":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}}}},"latestPrivacyStatement":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"company":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"latest":{"nullable":true,"type":"boolean"},"version":{"maxLength":5,"minLength":1,"nullable":true,"type":"string"},"publishedOn":{"nullable":true,"type":"string","format":"date-time"},"downloadUrl":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"type":{"enum":["termsofuse","privacystatement"],"nullable":false,"type":"string"},"languages":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"languageCode":{"maxLength":2,"minLength":2,"nullable":false,"type":"string"},"body":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"updateSummary":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"policy":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}}}},"branding":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"fqdn":{"maxLength":253,"minLength":4,"nullable":true,"pattern":".+(\\..[^.]+)","type":"string"},"theme":{"nullable":true,"type":"object","properties":{"primaryColor":{"maxLength":7,"minLength":6,"nullable":false,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"primaryTextColor":{"maxLength":7,"minLength":6,"nullable":false,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"accentColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"accentTextColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"headerColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"headerLineColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"menuColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"menuTextColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"pageColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"pageTextColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"cardColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"cardTextColor":{"maxLength":7,"minLength":6,"nullable":true,"pattern":"#?[a-fA-F0-9]{6,6}","type":"string"},"logoHasBackgroundColor":{"nullable":false,"type":"boolean"},"logoOnHeaderColorSpec":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"}}},"appleTouchIcon":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"favicon":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"logo":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"logoDark":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"appleAppStoreLink":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"googlePlayStoreLink":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"landingPageComponentTemplate":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"company":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"version":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"author":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"licence":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"url":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"sheetSettings":{"nullable":true,"type":"object","properties":{"minCols":{"maximum":11,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"defaultCols":{"maximum":11,"minimum":1,"nullable":true,"type":"integer","format":"int32"},"maxCols":{"maximum":11,"minimum":1,"nullable":true,"type":"integer","format":"int32"},"minRows":{"maximum":11,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"defaultRows":{"maximum":11,"minimum":1,"nullable":true,"type":"integer","format":"int32"},"maxRows":{"maximum":11,"minimum":1,"nullable":true,"type":"integer","format":"int32"}}},"cardSettings":{"nullable":true,"type":"object","properties":{"minHeight":{"maximum":65535,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"defaultHeight":{"maximum":65535,"minimum":1,"nullable":true,"type":"integer","format":"int32"},"maxHeight":{"maximum":65535,"minimum":1,"nullable":true,"type":"integer","format":"int32"}}},"inputs":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"draft":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"published":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"category":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}}},"configuredVersion":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"number":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"\\d+","type":"string"},"mainPath":{"maxLength":255,"minLength":4,"nullable":false,"type":"string"}}},"backendComponent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"static":{"nullable":false,"type":"boolean"},"intent":{"type":"array","items":{"enum":["asset-configuration","landing-page","main-page"],"nullable":false,"type":"string"}},"private":{"nullable":false,"type":"boolean"}}},"custom":{"nullable":false,"type":"object"}}},"premiumBrandingDomain":{"maxLength":253,"minLength":4,"nullable":true,"pattern":".+(\\..[^.]+)","type":"string"},"cdnDomain":{"maxLength":253,"minLength":4,"nullable":true,"pattern":".+(\\..[^.]+)","type":"string"},"poweredBy":{"nullable":true,"type":"object","properties":{"hide":{"nullable":false,"type":"boolean"},"logo":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"name":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"url":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"}}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"}]}},"/server-time":{"get":{"tags":["ServerTime"],"summary":"ServerTime","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"datetime":{"nullable":false,"type":"string","format":"date-time"}}}}}}}}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiBrandingOptional"}]}},"/server-validation":{"get":{"tags":["ServerValidation"],"summary":"ServerValidation","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"code":{"maxLength":8,"minLength":8,"nullable":false,"type":"string"},"expiresOn":{"nullable":false,"type":"string","format":"date-time"}}}}}}}}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiBrandingOptional"}]}},"/users/service-account/{publicId}":{"delete":{"tags":["ServiceAccount"],"summary":"ServiceAccount","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/users/service-account":{"post":{"tags":["ServiceAccountList"],"summary":"ServiceAccountList","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"apiApplication":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"token":{"maxLength":32,"minLength":32,"nullable":false,"type":"string"}},"required":["publicId","apiApplication","token"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}},"required":["name"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"delete":{"tags":["ServiceAccountList"],"summary":"ServiceAccountList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/agents/shell":{"post":{"tags":["ShellAgentList"],"summary":"ShellAgentList","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"conflictingAgents":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"registrationCode":{"maxLength":19,"minLength":1,"nullable":false,"pattern":"([A-Fa-f0-9]{4})(-([A-Fa-f0-9]{4})){3}","type":"string"},"registrationProfile":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"name":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"couponCode":{"maxLength":15,"minLength":15,"nullable":true,"pattern":"([1-9]{3}|[B-DF-HJ-NP-TV-Z]{3})(-([1-9]{3}|[B-DF-HJ-NP-TV-Z]{3})){3}","type":"string"},"licence":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"groups":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}},"template":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}},"required":["registrationCode"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/sso/access-token":{"post":{"tags":["SsoAccessTokenList"],"summary":"SsoAccessTokenList","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"expiresOn":{"nullable":false,"type":"string","format":"date-time"},"secretId":{"maxLength":32,"minLength":32,"nullable":false,"type":"string"},"user":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"type":{"enum":["person","service_account"],"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"emailAddress":{"maxLength":254,"minLength":6,"nullable":true,"pattern":"^(?=.{1,254}$)(?=.{1,64}@)[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+(?:\\.[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+)*@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$","type":"string"},"support":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"},"hasPassword":{"nullable":false,"type":"boolean"},"externallyManaged":{"nullable":false,"type":"boolean"},"language":{"maxLength":2,"minLength":2,"nullable":false,"type":"string"},"localisation":{"maxLength":10,"minLength":1,"nullable":true,"type":"string"},"timeZone":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"registeredOn":{"nullable":false,"type":"string","format":"date-time"},"lastSeenOn":{"nullable":false,"type":"string","format":"date-time"},"registeredBy":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"emailAddressChanges":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"oldEmailAddress":{"maxLength":254,"minLength":6,"nullable":false,"pattern":"^(?=.{1,254}$)(?=.{1,64}@)[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+(?:\\.[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+)*@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$","type":"string"},"newEmailAddress":{"maxLength":254,"minLength":6,"nullable":false,"pattern":"^(?=.{1,254}$)(?=.{1,64}@)[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+(?:\\.[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+)*@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$","type":"string"},"expiresOn":{"nullable":false,"type":"string","format":"date-time"}}}},"invites":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"emailAddress":{"maxLength":254,"minLength":6,"nullable":false,"pattern":"^(?=.{1,254}$)(?=.{1,64}@)[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+(?:\\.[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+)*@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$","type":"string"},"expiresOn":{"nullable":false,"type":"string","format":"date-time"},"memberships":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"user":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"invite":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"group":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"role":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"expiresOn":{"nullable":true,"type":"string","format":"date-time"}}}}}}},"unreadMessagesCount":{"maximum":2147483647,"minimum":-2147483648,"nullable":false,"type":"integer","format":"int32"},"otpAuth":{"nullable":false,"type":"object","properties":{"required":{"nullable":false,"type":"boolean"},"deviceName":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"registeredOn":{"nullable":true,"type":"string","format":"date-time"},"tokenExpiresOn":{"nullable":true,"type":"string","format":"date-time"},"type":{"enum":["app","sms"],"nullable":true,"type":"string"}}},"apiApplications":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"custom":{"nullable":false,"type":"object"}}}},"phoneNumber":{"maxLength":16,"minLength":3,"nullable":true,"pattern":"\\+[0-9]{2,15}","type":"string"},"acceptedTermsOfUsePolicies":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"policy":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"company":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"latest":{"nullable":true,"type":"boolean"},"version":{"maxLength":5,"minLength":1,"nullable":true,"type":"string"},"publishedOn":{"nullable":true,"type":"string","format":"date-time"},"downloadUrl":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"type":{"enum":["termsofuse","privacystatement"],"nullable":false,"type":"string"},"languages":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"languageCode":{"maxLength":2,"minLength":2,"nullable":false,"type":"string"},"body":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"updateSummary":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"policy":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}}}},"company":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"acceptedOn":{"nullable":false,"type":"string","format":"date-time"}}}}}},"ssoIdentityProvider":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"companies":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"logo":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"expiresIn":{"maximum":5184000,"minimum":60,"nullable":false,"type":"integer","format":"int32"},"trustedDeviceName":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"scope":{"oneOf":[{"type":"object","properties":{"type":{"enum":["unrestricted"],"nullable":false,"type":"string"}},"required":["type"]},{"type":"object","properties":{"type":{"enum":["allow"],"nullable":false,"type":"string"},"rels":{"type":"array","items":{"nullable":false,"type":"object","properties":{"rel":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"get":{"nullable":true,"type":"boolean"},"post":{"nullable":true,"type":"boolean"},"patch":{"nullable":true,"type":"boolean"},"delete":{"nullable":true,"type":"boolean"},"put":{"nullable":true,"type":"boolean"}}}}},"required":["type","rels"]},{"type":"object","properties":{"type":{"enum":["deny"],"nullable":false,"type":"string"},"rels":{"type":"array","items":{"nullable":false,"type":"object","properties":{"rel":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"get":{"nullable":true,"type":"boolean"},"post":{"nullable":true,"type":"boolean"},"patch":{"nullable":true,"type":"boolean"},"delete":{"nullable":true,"type":"boolean"},"put":{"nullable":true,"type":"boolean"}}}}},"required":["type","rels"]}]},"ssoAuthentication":{"nullable":false,"type":"object","properties":{"code":{"maxLength":4294967295,"minLength":0,"nullable":false,"type":"string"},"state":{"maxLength":286,"minLength":1,"nullable":false,"type":"string"}}}},"required":["expiresIn","ssoAuthentication"]}}}}}},"/sso/authentication/request":{"post":{"tags":["SsoAuthenticationRequestList"],"summary":"SsoAuthenticationRequestList","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"url":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"identityProvider":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"redirectUrl":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}},"required":["identityProvider","redirectUrl"]}}}}}},"/sso/identity-providers":{"get":{"tags":["SsoIdentityProviderList"],"summary":"SsoIdentityProviderList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"companies":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"logo":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"}]}},"/sso/redirect/{api-version}":{"get":{"tags":["SsoRedirect"],"summary":"SsoRedirect","responses":{"302":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"api-version","in":"path","schema":{"type":"string"}}]}},"/sso/registrations":{"post":{"tags":["SsoRegistrationList"],"summary":"SsoRegistrationList","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingRequired"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"companyName":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"language":{"maxLength":2,"minLength":2,"nullable":false,"type":"string"},"localisation":{"maxLength":10,"minLength":1,"nullable":false,"type":"string"},"timeZone":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"termsOfUsePolicy":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"ssoAuthentication":{"nullable":false,"type":"object","properties":{"code":{"maxLength":4294967295,"minLength":0,"nullable":false,"type":"string"},"state":{"maxLength":286,"minLength":1,"nullable":false,"type":"string"}}}},"required":["companyName","ssoAuthentication"]}}}}}},"/terms-of-use-policies/{publicId}":{"get":{"tags":["TermsOfUsePolicy"],"summary":"TermsOfUsePolicy","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"company":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"latest":{"nullable":true,"type":"boolean"},"version":{"maxLength":5,"minLength":1,"nullable":true,"type":"string"},"publishedOn":{"nullable":true,"type":"string","format":"date-time"},"downloadUrl":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"type":{"enum":["termsofuse","privacystatement"],"nullable":false,"type":"string"},"languages":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"languageCode":{"maxLength":2,"minLength":2,"nullable":false,"type":"string"},"body":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"updateSummary":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"policy":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}]}},"/terms-of-use-policies/{publicId}/accept":{"post":{"tags":["TermsOfUsePolicyAccept"],"summary":"TermsOfUsePolicyAccept","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/terms-of-use-policies/{publicId}/download":{"get":{"tags":["TermsOfUsePolicyDownload"],"summary":"TermsOfUsePolicyDownload","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}]}},"/terms-of-use-policies":{"get":{"tags":["TermsOfUsePolicyList"],"summary":"TermsOfUsePolicyList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"company":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"latest":{"nullable":true,"type":"boolean"},"version":{"maxLength":5,"minLength":1,"nullable":true,"type":"string"},"publishedOn":{"nullable":true,"type":"string","format":"date-time"},"downloadUrl":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"type":{"enum":["termsofuse","privacystatement"],"nullable":false,"type":"string"},"languages":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"languageCode":{"maxLength":2,"minLength":2,"nullable":false,"type":"string"},"body":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"updateSummary":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"policy":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"}]}},"/translations":{"get":{"tags":["TranslationList"],"summary":"TranslationList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"key":{"maxLength":255,"minLength":1,"nullable":false,"pattern":"^[A-Z0-9_?.!]+$","type":"string"},"languages":{"maxLength":65535,"nullable":false,"type":"object"}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"}],"security":[{"bearerToken":[]}]},"post":{"tags":["TranslationList"],"summary":"TranslationList","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"key":{"maxLength":255,"minLength":1,"nullable":false,"pattern":"[A-Z0-9_?.!]+","type":"string"},"languages":{"maxLength":65535,"nullable":false,"type":"object"}},"required":["key","languages"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"patch":{"tags":["TranslationList"],"summary":"TranslationList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"languages":{"maxLength":65535,"nullable":false,"type":"object"}}}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"delete":{"tags":["TranslationList"],"summary":"TranslationList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/trusted-devices/{publicId}":{"delete":{"tags":["TrustedDevice"],"summary":"TrustedDevice","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/trusted-devices":{"get":{"tags":["TrustedDeviceList"],"summary":"TrustedDeviceList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"user":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"userAgent":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"isCurrent":{"nullable":false,"type":"boolean"},"createdOn":{"nullable":false,"type":"string","format":"date-time"},"createdOnGeoLocation":{"nullable":false,"type":"object","properties":{"latitude":{"nullable":false,"type":"string"},"longitude":{"nullable":false,"type":"string"},"country":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"city":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"lastLogin":{"nullable":false,"type":"string","format":"date-time"},"lastLoginGeoLocation":{"nullable":false,"type":"object","properties":{"latitude":{"nullable":false,"type":"string"},"longitude":{"nullable":false,"type":"string"},"country":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"city":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"}],"security":[{"bearerToken":[]}]},"delete":{"tags":["TrustedDeviceList"],"summary":"TrustedDeviceList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/users/{publicId}":{"get":{"tags":["User"],"summary":"User","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"type":{"enum":["person","service_account"],"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"emailAddress":{"maxLength":254,"minLength":6,"nullable":true,"pattern":"^(?=.{1,254}$)(?=.{1,64}@)[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+(?:\\.[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+)*@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$","type":"string"},"support":{"nullable":false,"type":"boolean"},"registeredOn":{"nullable":true,"type":"string","format":"date-time"},"lastSeenOn":{"nullable":true,"type":"string","format":"date-time"},"registeredBy":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"memberships":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"user":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"invite":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"group":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"role":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"expiresOn":{"nullable":true,"type":"string","format":"date-time"}}}},"apiApplications":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"custom":{"nullable":false,"type":"object"}}}},"custom":{"nullable":false,"type":"object"},"otpauthRequired":{"nullable":false,"type":"boolean"}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"delete":{"tags":["User"],"summary":"User","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/users":{"get":{"tags":["UserList"],"summary":"UserList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"type":{"enum":["person","service_account"],"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"emailAddress":{"maxLength":254,"minLength":6,"nullable":true,"pattern":"^(?=.{1,254}$)(?=.{1,64}@)[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+(?:\\.[a-zA-Z0-9!#$%&\\'*+/=?^_`{|}~-]+)*@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$","type":"string"},"support":{"nullable":false,"type":"boolean"},"registeredOn":{"nullable":true,"type":"string","format":"date-time"},"lastSeenOn":{"nullable":true,"type":"string","format":"date-time"},"registeredBy":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"memberships":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"user":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"invite":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"group":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"role":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"expiresOn":{"nullable":true,"type":"string","format":"date-time"}}}},"apiApplications":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"custom":{"nullable":false,"type":"object"}}}},"custom":{"nullable":false,"type":"object"},"otpauthRequired":{"nullable":false,"type":"boolean"}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"}],"security":[{"bearerToken":[]}]},"post":{"tags":["UserList"],"summary":"UserList","responses":{"201":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"password":{"minLength":8,"nullable":false,"type":"string"},"ssoAuthentication":{"nullable":false,"type":"object","properties":{"code":{"maxLength":4294967295,"minLength":0,"nullable":false,"type":"string"},"state":{"maxLength":286,"minLength":1,"nullable":false,"type":"string"}}},"language":{"maxLength":2,"minLength":2,"nullable":false,"type":"string"},"localisation":{"maxLength":10,"minLength":1,"nullable":true,"type":"string"},"timeZone":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"termsOfUsePolicy":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}}}}},"delete":{"tags":["UserList"],"summary":"UserList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/users/memberships/{publicId}":{"get":{"tags":["UserMembership"],"summary":"UserMembership","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"user":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"invite":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"group":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"role":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"expiresOn":{"nullable":true,"type":"string","format":"date-time"}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"patch":{"tags":["UserMembership"],"summary":"UserMembership","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"group":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"role":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"expiresOn":{"nullable":true,"type":"string","format":"date-time"}}}}}},"security":[{"bearerToken":[]}]},"delete":{"tags":["UserMembership"],"summary":"UserMembership","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/users/memberships":{"get":{"tags":["UserMembershipList"],"summary":"UserMembershipList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"user":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"invite":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"group":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"role":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"expiresOn":{"nullable":true,"type":"string","format":"date-time"}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"}],"security":[{"bearerToken":[]}]},"post":{"tags":["UserMembershipList"],"summary":"UserMembershipList","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"user":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"invite":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"group":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"role":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"expiresOn":{"nullable":true,"type":"string","format":"date-time"}},"required":["group","role"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"patch":{"tags":["UserMembershipList"],"summary":"UserMembershipList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"group":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"role":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"expiresOn":{"nullable":true,"type":"string","format":"date-time"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"delete":{"tags":["UserMembershipList"],"summary":"UserMembershipList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/users/memberships/user/{publicId}":{"put":{"tags":["UserMembershipUserList"],"summary":"UserMembershipUserList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"group":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"role":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"expiresOn":{"nullable":true,"type":"string","format":"date-time"}},"required":["group"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/user-zone-grants":{"get":{"tags":["UserZoneGrantsList"],"summary":"UserZoneGrantsList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"user":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"zone":{"oneOf":[{"type":"object","properties":{"type":{"enum":["c"],"nullable":false,"type":"string"}},"required":["type"]},{"type":"object","properties":{"type":{"enum":["g"],"nullable":false,"type":"string"},"publicId":{"maxLength":12,"minLength":12,"nullable":true,"type":"string"}},"required":["type"]},{"type":"object","properties":{"type":{"enum":["s"],"nullable":false,"type":"string"},"publicId":{"maxLength":12,"minLength":12,"nullable":true,"type":"string"}},"required":["type"]},{"type":"object","properties":{"type":{"enum":["a"],"nullable":false,"type":"string"},"publicId":{"maxLength":12,"minLength":12,"nullable":true,"type":"string"}},"required":["type"]}]},"startsOn":{"nullable":true,"type":"string","format":"date-time"},"expiresOn":{"nullable":true,"type":"string","format":"date-time"},"grants":{"type":"array","items":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"}],"security":[{"bearerToken":[]}]}},"/vpn-usage":{"post":{"tags":["VpnUsage"],"summary":"VpnUsage","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"bytesSent":{"minimum":1,"nullable":false,"type":"integer","format":"int32"},"bytesReceived":{"minimum":1,"nullable":false,"type":"integer","format":"int32"},"year":{"minimum":2000,"nullable":false,"type":"integer","format":"int32"},"month":{"maximum":12,"minimum":1,"nullable":true,"type":"integer","format":"int32"},"day":{"maximum":31,"minimum":1,"nullable":true,"type":"integer","format":"int32"},"hour":{"maximum":23,"nullable":true,"type":"integer","format":"int32"}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"aggregator":{"enum":["hourly","daily","monthly","yearly"],"nullable":false,"type":"string"},"before":{"nullable":false,"type":"string","format":"date-time"},"after":{"nullable":false,"type":"string","format":"date-time"}}}}}},"security":[{"bearerToken":[]}]}},"/vpn-usage-2":{"post":{"tags":["VpnUsageList"],"summary":"VpnUsageList","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"bytesSent":{"minimum":1,"nullable":false,"type":"integer","format":"int32"},"bytesReceived":{"minimum":1,"nullable":false,"type":"integer","format":"int32"},"year":{"minimum":2000,"nullable":false,"type":"integer","format":"int32"},"month":{"maximum":12,"minimum":1,"nullable":true,"type":"integer","format":"int32"},"day":{"maximum":31,"minimum":1,"nullable":true,"type":"integer","format":"int32"},"hour":{"maximum":23,"nullable":true,"type":"integer","format":"int32"}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"aggregator":{"enum":["hourly","daily","monthly","yearly"],"nullable":false,"type":"string"},"before":{"nullable":false,"type":"string","format":"date-time"},"after":{"nullable":false,"type":"string","format":"date-time"}},"required":["aggregator","before","after"]}}}},"security":[{"bearerToken":[]}]}},"/web-access":{"post":{"tags":["WebAccess"],"summary":"WebAccess","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":50,"minLength":1,"nullable":false,"type":"string"},"url":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}},"required":["publicId","url"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"server":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}},"required":["server"]}}}},"security":[{"bearerToken":[]}]}},"/web-accesses/{publicId}":{"get":{"tags":["WebAccessEntry"],"summary":"WebAccessEntry","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":50,"minLength":1,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"deviceId":{"maxLength":128,"minLength":1,"nullable":false,"type":"string"},"type":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"additionalSubnets":{"nullable":false,"type":"boolean"},"allowDataPublishing":{"nullable":false,"type":"boolean"},"allowDemoDevice":{"nullable":false,"type":"boolean"},"allowTemplating":{"nullable":false,"type":"boolean"},"allowReboot":{"nullable":false,"type":"boolean"},"configPush":{"nullable":false,"type":"boolean"},"configFileFormat":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"customServers":{"nullable":false,"type":"boolean"},"deviceIdFormat":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"httpProxyPort":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"latestFirmwareFile":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"code":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"notes":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"agentType":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"type":{"enum":["firmware"],"nullable":false,"type":"string"},"latest":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"offlineConfiguration":{"nullable":false,"type":"boolean"},"openvpnConfigMultiUse":{"nullable":false,"type":"boolean"},"purchasePrice":{"nullable":false,"type":"object","properties":{"gratis":{"nullable":false,"type":"boolean"}}},"router":{"nullable":false,"type":"boolean"},"stunnelSupport":{"nullable":false,"type":"boolean"},"wanPortForwardings":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"},"hasSecondWanPort":{"nullable":false,"type":"boolean"}}},"location":{"nullable":true,"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"latitude":{"nullable":false,"type":"string"},"longitude":{"nullable":false,"type":"string"}}},"geoLocation":{"nullable":true,"type":"object","properties":{"latitude":{"nullable":false,"type":"string"},"longitude":{"nullable":false,"type":"string"},"country":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"city":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"timeZone":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"custom":{"nullable":false,"type":"object"},"description":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"useStunnel":{"nullable":false,"type":"boolean"},"preferLocationOverGeoip":{"nullable":false,"type":"boolean"},"reRegistration":{"nullable":false,"type":"boolean"},"replaceRegistration":{"nullable":false,"type":"boolean"},"replaceMacAddress":{"maxLength":17,"minLength":0,"nullable":true,"pattern":"[0-9a-fA-F]{2}(:[0-9a-fA-F]{2}){5}","type":"string"},"fixedVpnAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"macAddress":{"maxLength":17,"minLength":1,"nullable":false,"type":"string"},"serialNumber":{"maxLength":128,"minLength":1,"nullable":false,"type":"string"},"pullCodeGeneratedOn":{"nullable":true,"type":"string","format":"date-time"},"controlKeyGeneratedOn":{"nullable":true,"type":"string","format":"date-time"},"lastSeenAgentUserAgent":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"value":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"configName":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"configVersion":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"hardware":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"hardwareCode":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"hardwareVersion":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"firmwareVersion":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"osName":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"osVersion":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"appName":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"appVersion":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"packageName":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"packageVersion":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"libixagentVersion":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"libixloggerVersion":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"logOnTrigger":{"nullable":false,"type":"boolean"},"alarming":{"nullable":false,"type":"boolean"},"dataMonitoring":{"nullable":false,"type":"boolean"},"wifi":{"nullable":false,"type":"boolean"},"remoteFirmwareUpgrade":{"nullable":false,"type":"boolean"},"staticMapping":{"nullable":false,"type":"boolean"},"stewardConfigPush":{"nullable":false,"type":"boolean"},"wanInterfaceEth0":{"nullable":false,"type":"boolean"},"wanInterfaceWifi0":{"nullable":false,"type":"boolean"},"wanInterfaceCell0":{"enum":["3G","4G","neither"],"nullable":false,"type":"string"},"multiWan":{"nullable":false,"type":"boolean"},"openvpnVersion":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"openvpnOccEnabled":{"nullable":false,"type":"boolean"},"openvpnOpensslVersion":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"}}},"networkValues":{"type":"array","items":{"nullable":false,"type":"object","properties":{"interface":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"value":{"type":"array","items":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}}}}},"networkReportedOn":{"nullable":true,"type":"string","format":"date-time"},"activeStatus":{"enum":["active","inactive"],"nullable":false,"type":"string"},"activationLicence":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"type":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"usageType":{"enum":["advanced-user-management","agent-registration-profile","agent-templates","alarming","api-integrations","app-engine-level-1","app-engine-level-2","app-engine-level-3","asset-management","card-view","connection-monitoring","controlled-devices","custom-branding","custom-domain","custom-fields","custom-legal","custom-legal-legacy","custom-sso","edge-app-management","ixagent","landing-page","live-data","logging","m2m-cloud-cluster","main-pages","mobile-app","mqtt-device","object-storage","premium-branding","rdp","remote-access","reporting","request-access","rtsp","scim","session-recording","sla","ssh","subgroups","temporary-access","vpn-access-rule","vpn-usage"],"nullable":false,"type":"string"},"companyLimit":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"scope":{"enum":["agent","company"],"nullable":false,"type":"string"}}},"serialNumber":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"expiresOn":{"nullable":true,"type":"string","format":"date-time"},"activated":{"nullable":false,"type":"boolean"},"trial":{"nullable":false,"type":"boolean"},"value":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"locked":{"nullable":true,"type":"boolean"},"maxRetentionPolicy":{"maxLength":255,"minLength":2,"nullable":true,"type":"string"},"bundle":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}},"pendingRegistration":{"nullable":false,"type":"boolean"},"card":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"activeVpnSession":{"nullable":true,"type":"object","properties":{"rscServer":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"vpnRange":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"supportedLayers":{"type":"array","items":{"enum":["tun","tap"],"nullable":false,"type":"string"}},"location":{"nullable":false,"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"latitude":{"nullable":false,"type":"string"},"longitude":{"nullable":false,"type":"string"}}}}},"startedOn":{"nullable":false,"type":"string","format":"date-time"},"sessionName":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"vpnAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"closed":{"nullable":false,"type":"boolean"}}},"vpnChangedOn":{"nullable":true,"type":"string","format":"date-time"},"mdrServer":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"mqttChangedOn":{"nullable":true,"type":"string","format":"date-time"},"loggingMdrServer":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"loggingMqttChangedOn":{"nullable":true,"type":"string","format":"date-time"},"lsiServer":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"company":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":24,"minLength":24,"nullable":false,"pattern":"(\\d{4}-){4}\\d{4}","type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"controlledBy":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":24,"minLength":24,"nullable":false,"pattern":"(\\d{4}-){4}\\d{4}","type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"vpnAudience":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"custom":{"nullable":false,"type":"object"},"default":{"nullable":false,"type":"boolean"},"type":{"enum":["alarm","page","service"],"nullable":true,"type":"string"}}},"vpnRequireAccessApproval":{"nullable":false,"type":"boolean"},"vpnAccessRules":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"audience":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"ipAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"netMask":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}}}},"vpnVisibleInMobileApp":{"nullable":false,"type":"boolean"},"vpnVisibleOnWeb":{"nullable":false,"type":"boolean"},"dataAudience":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"custom":{"nullable":false,"type":"object"},"default":{"nullable":false,"type":"boolean"},"type":{"enum":["alarm","page","service"],"nullable":true,"type":"string"}}},"memberships":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"group":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}},"rateLimiting":{"nullable":false,"type":"object","properties":{"configMqttCommandLimit":{"enum":["soft","hard","lock"],"nullable":true,"type":"string"},"configMqttCommandCounter":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"configMqttCommandLastHit":{"nullable":true,"type":"string","format":"date-time"},"configMqttDataLimit":{"enum":["soft","hard","lock"],"nullable":true,"type":"string"},"configMqttDataCounter":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"configMqttDataLastHit":{"nullable":true,"type":"string","format":"date-time"},"configOpenvpnLimit":{"enum":["soft","hard","lock"],"nullable":true,"type":"string"},"configOpenvpnCounter":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"configOpenvpnLastHit":{"nullable":true,"type":"string","format":"date-time"}}},"vpnProtocol":{"enum":["udp","tcp"],"nullable":false,"type":"string"},"config":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"configFileServer":{"maxLength":4294967295,"minLength":0,"nullable":true,"type":"string"},"configPushedOn":{"nullable":true,"type":"string","format":"date-time"},"configFileReported":{"maxLength":4294967295,"minLength":0,"nullable":true,"type":"string"},"configFileReportedWlanKeyEnabled":{"nullable":false,"type":"boolean"},"configFileReportedCellularPasswordEnabled":{"nullable":false,"type":"boolean"},"configReportedOn":{"nullable":true,"type":"string","format":"date-time"},"differentConfigs":{"nullable":false,"type":"boolean"},"differentWanConfigs":{"nullable":false,"type":"boolean"},"stewardConfigFileServer":{"maxLength":4294967295,"minLength":0,"nullable":true,"type":"string"},"stewardConfigFileReported":{"maxLength":4294967295,"minLength":0,"nullable":true,"type":"string"},"stewardConfigReportedOn":{"nullable":true,"type":"string","format":"date-time"},"differentStewardConfigs":{"nullable":false,"type":"boolean"},"routerLan":{"nullable":false,"type":"object","properties":{"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"ipAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"netMask":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"network":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"dhcpServerEnabled":{"nullable":false,"type":"boolean"},"dhcpServerRangeFrom":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"dhcpServerRangeTo":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"gatewayLessRouting":{"nullable":false,"type":"boolean"},"forwardLanWan":{"enum":["neither","public","private","both"],"nullable":false,"type":"string"},"forwardLanWan2":{"enum":["neither","public","private","both"],"nullable":false,"type":"string"},"wlanEnable":{"nullable":true,"type":"boolean"},"wlanSsid":{"maxLength":32,"minLength":0,"nullable":true,"type":"string"},"wlanKey":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"wlanChannel":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"bacnetBbmd":{"type":"array","items":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}},"udpBroadcastRelayPort":{"type":"array","items":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}}}},"routerVpn":{"nullable":false,"type":"object","properties":{"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"sourceNatEnabled":{"nullable":false,"type":"boolean"}}},"routerWan":{"nullable":false,"type":"object","properties":{"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"multiwanPolicy":{"enum":["eth_cell_wifi","cell_eth_wifi","eth_wifi_cell","wifi_eth_cell","cell_wifi_eth","wifi_cell_eth"],"nullable":true,"type":"string"},"ipUseDhcp":{"nullable":true,"type":"boolean"},"ipAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"ipGateway":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"ipNetMask":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"dnsServers":{"type":"array","items":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}},"dnsRebindProtectionEnabled":{"nullable":true,"type":"boolean"},"cellularApn":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"cellularPincode":{"maxLength":8,"minLength":0,"nullable":true,"type":"string"},"cellularMtu":{"maximum":1500,"minimum":576,"nullable":true,"type":"integer","format":"int32"},"digitalInputMode":{"enum":["disable_vpn_high","disable_vpn_low","disable_wan_high","disable_wan_low"],"nullable":true,"type":"string"},"wanTrackInterval":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"wanTrackIps":{"type":"array","items":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}},"wlanTrackInterval":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"wlanTrackIps":{"type":"array","items":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}},"cellularTrackInterval":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"cellularTrackIps":{"type":"array","items":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}},"httpProxyAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"httpProxyPort":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"httpProxyAuthentication":{"enum":["none","basic","ntlm"],"nullable":true,"type":"string"},"httpProxyUsername":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"httpProxyIsSocks5":{"nullable":true,"type":"boolean"},"wlanSsid":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"wlanIpUseDhcp":{"nullable":true,"type":"boolean"},"wlanIpAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"wlanIpGateway":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"wlanIpNetMask":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"wlanDnsServers":{"type":"array","items":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}},"cellularUsername":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"}}},"routerDisplay":{"nullable":false,"type":"object","properties":{"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"lockEnabled":{"nullable":false,"type":"boolean"},"lockCode":{"maxLength":4,"minLength":4,"nullable":true,"pattern":"[0-9]+","type":"string"}}},"routerAdditionalSubnets":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"networkAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"networkMask":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"gatewayAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}},"routerPortForwards":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"interface":{"enum":["VPN","WAN","WAN2"],"nullable":false,"type":"string"},"targetIpAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"targetPort":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"externalPort":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}},"routerNtpServers":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"server":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}}},"demoDevice":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"expiresOn":{"nullable":false,"type":"string","format":"date-time"},"agentType":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"additionalSubnets":{"nullable":false,"type":"boolean"},"allowDataPublishing":{"nullable":false,"type":"boolean"},"allowDemoDevice":{"nullable":false,"type":"boolean"},"allowTemplating":{"nullable":false,"type":"boolean"},"allowReboot":{"nullable":false,"type":"boolean"},"configPush":{"nullable":false,"type":"boolean"},"configFileFormat":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"customServers":{"nullable":false,"type":"boolean"},"deviceIdFormat":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"httpProxyPort":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"latestFirmwareFile":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"code":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"notes":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"agentType":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"type":{"enum":["firmware"],"nullable":false,"type":"string"},"latest":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"offlineConfiguration":{"nullable":false,"type":"boolean"},"openvpnConfigMultiUse":{"nullable":false,"type":"boolean"},"purchasePrice":{"nullable":false,"type":"object","properties":{"gratis":{"nullable":false,"type":"boolean"}}},"router":{"nullable":false,"type":"boolean"},"stunnelSupport":{"nullable":false,"type":"boolean"},"wanPortForwardings":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"},"hasSecondWanPort":{"nullable":false,"type":"boolean"}}},"dmvServer":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}},"connectedUsers":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}},"loggingApp":{"nullable":false,"type":"object","properties":{"licence":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"type":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"usageType":{"enum":["advanced-user-management","agent-registration-profile","agent-templates","alarming","api-integrations","app-engine-level-1","app-engine-level-2","app-engine-level-3","asset-management","card-view","connection-monitoring","controlled-devices","custom-branding","custom-domain","custom-fields","custom-legal","custom-legal-legacy","custom-sso","edge-app-management","ixagent","landing-page","live-data","logging","m2m-cloud-cluster","main-pages","mobile-app","mqtt-device","object-storage","premium-branding","rdp","remote-access","reporting","request-access","rtsp","scim","session-recording","sla","ssh","subgroups","temporary-access","vpn-access-rule","vpn-usage"],"nullable":false,"type":"string"},"companyLimit":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"scope":{"enum":["agent","company"],"nullable":false,"type":"string"}}},"serialNumber":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"expiresOn":{"nullable":true,"type":"string","format":"date-time"},"activated":{"nullable":false,"type":"boolean"},"trial":{"nullable":false,"type":"boolean"},"value":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"locked":{"nullable":true,"type":"boolean"},"maxRetentionPolicy":{"maxLength":255,"minLength":2,"nullable":true,"type":"string"},"agent":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"deviceId":{"maxLength":128,"minLength":1,"nullable":false,"type":"string"},"type":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"location":{"nullable":false,"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"latitude":{"nullable":false,"type":"string"},"longitude":{"nullable":false,"type":"string"}}},"geoLocation":{"nullable":false,"type":"object","properties":{"latitude":{"nullable":false,"type":"string"},"longitude":{"nullable":false,"type":"string"},"country":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"city":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"custom":{"nullable":false,"type":"object"}}},"hasAgent":{"nullable":false,"type":"boolean"},"agentType":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"additionalSubnets":{"nullable":false,"type":"boolean"},"allowDataPublishing":{"nullable":false,"type":"boolean"},"allowDemoDevice":{"nullable":false,"type":"boolean"},"allowTemplating":{"nullable":false,"type":"boolean"},"allowReboot":{"nullable":false,"type":"boolean"},"configPush":{"nullable":false,"type":"boolean"},"configFileFormat":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"customServers":{"nullable":false,"type":"boolean"},"deviceIdFormat":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"httpProxyPort":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"latestFirmwareFile":{"nullable":false,"type":"object"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"offlineConfiguration":{"nullable":false,"type":"boolean"},"openvpnConfigMultiUse":{"nullable":false,"type":"boolean"},"purchasePrice":{"nullable":false,"type":"object"},"router":{"nullable":false,"type":"boolean"},"stunnelSupport":{"nullable":false,"type":"boolean"},"wanPortForwardings":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"},"hasSecondWanPort":{"nullable":false,"type":"boolean"}}},"bundle":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}},"enabled":{"nullable":false,"type":"boolean"}}},"valuesPerHour":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"alarmingApp":{"nullable":false,"type":"object","properties":{"licence":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"type":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"usageType":{"enum":["advanced-user-management","agent-registration-profile","agent-templates","alarming","api-integrations","app-engine-level-1","app-engine-level-2","app-engine-level-3","asset-management","card-view","connection-monitoring","controlled-devices","custom-branding","custom-domain","custom-fields","custom-legal","custom-legal-legacy","custom-sso","edge-app-management","ixagent","landing-page","live-data","logging","m2m-cloud-cluster","main-pages","mobile-app","mqtt-device","object-storage","premium-branding","rdp","remote-access","reporting","request-access","rtsp","scim","session-recording","sla","ssh","subgroups","temporary-access","vpn-access-rule","vpn-usage"],"nullable":false,"type":"string"},"companyLimit":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"scope":{"enum":["agent","company"],"nullable":false,"type":"string"}}},"serialNumber":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"expiresOn":{"nullable":true,"type":"string","format":"date-time"},"activated":{"nullable":false,"type":"boolean"},"trial":{"nullable":false,"type":"boolean"},"value":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"locked":{"nullable":true,"type":"boolean"},"maxRetentionPolicy":{"maxLength":255,"minLength":2,"nullable":true,"type":"string"},"agent":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"deviceId":{"maxLength":128,"minLength":1,"nullable":false,"type":"string"},"type":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"location":{"nullable":false,"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"latitude":{"nullable":false,"type":"string"},"longitude":{"nullable":false,"type":"string"}}},"geoLocation":{"nullable":false,"type":"object","properties":{"latitude":{"nullable":false,"type":"string"},"longitude":{"nullable":false,"type":"string"},"country":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"city":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"custom":{"nullable":false,"type":"object"}}},"hasAgent":{"nullable":false,"type":"boolean"},"agentType":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"additionalSubnets":{"nullable":false,"type":"boolean"},"allowDataPublishing":{"nullable":false,"type":"boolean"},"allowDemoDevice":{"nullable":false,"type":"boolean"},"allowTemplating":{"nullable":false,"type":"boolean"},"allowReboot":{"nullable":false,"type":"boolean"},"configPush":{"nullable":false,"type":"boolean"},"configFileFormat":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"customServers":{"nullable":false,"type":"boolean"},"deviceIdFormat":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"httpProxyPort":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"latestFirmwareFile":{"nullable":false,"type":"object"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"offlineConfiguration":{"nullable":false,"type":"boolean"},"openvpnConfigMultiUse":{"nullable":false,"type":"boolean"},"purchasePrice":{"nullable":false,"type":"object"},"router":{"nullable":false,"type":"boolean"},"stunnelSupport":{"nullable":false,"type":"boolean"},"wanPortForwardings":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"},"hasSecondWanPort":{"nullable":false,"type":"boolean"}}},"bundle":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}},"enabled":{"nullable":false,"type":"boolean"}}},"lanWanAccessRules":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"sourceIpAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"sourceMacAddress":{"maxLength":17,"minLength":17,"nullable":true,"pattern":"[0-9a-fA-F]{2}(:[0-9a-fA-F]{2}){5}","type":"string"},"destinationPort":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"destinationIpAddress":{"maxLength":19,"minLength":7,"nullable":true,"pattern":"\\d{1,3}(\\.\\d{1,3}){3}(\\/\\d{1,3})?","type":"string"},"protocol":{"enum":["all","tcp","udp","icmp","ah","ax.25","dccp","ddp","egp","eigrp","encap","esp","etherip","fc","ggp","gre","hmp","idpr-cmtp","idrp","igmp","igp","ipcomp","ipencap","ipip","ipv6","ipv6-frag","ipv6-icmp","ipv6-nonxt","ipv6-opts","ipv6-route","isis","iso-tp4","l2tp","ospf","pim","pup","rdp","rspf","rsvp","sctp","skip","st","vmtp","vrrp","xns-idp","xtp"],"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"}}}},"oneToOneNatRules":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"type":{"enum":["wan","wlan","vpn"],"nullable":false,"type":"string"},"virtualIpAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"destinationIpAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"protocol":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"port":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"sourceIpAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"}}}},"devices":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"ipAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"macAddress":{"maxLength":17,"minLength":17,"nullable":true,"pattern":"[0-9a-fA-F]{2}(:[0-9a-fA-F]{2}){5}","type":"string"},"customAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"dataSources":{"type":"array","items":{"nullable":false,"type":"object","properties":{"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"continueLoggingOnError":{"nullable":true,"type":"boolean"},"device":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"gracePeriod":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"slug":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"^[a-zA-Z0-9_\\[\\]-]+$","type":"string"},"disabled":{"nullable":false,"type":"boolean"},"protocol":{"oneOf":[{"type":"object","properties":{"publicId":{"enum":["custom"],"nullable":false,"type":"string"},"password":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}},"required":["publicId","password"]},{"type":"object","properties":{"publicId":{"enum":["modbus"],"nullable":false,"type":"string"},"slave":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"format":{"enum":["ABCD","BADC","CDAB","DCBA"],"nullable":true,"type":"string"},"readMode":{"enum":["single_value","consecutive_values","gapped_values"],"nullable":true,"type":"string"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["siemens-step7"],"nullable":false,"type":"string"},"pdu":{"maximum":2147483647,"minimum":-2147483648,"nullable":true,"type":"integer","format":"int32"},"rack":{"maximum":7,"nullable":true,"type":"integer","format":"int32"},"slot":{"maximum":31,"nullable":true,"type":"integer","format":"int32"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["opc-ua"],"nullable":false,"type":"string"},"authenticationType":{"enum":["anonymous","username","certificate"],"nullable":false,"type":"string"},"username":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"password":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"securityMode":{"enum":["sign","signandencrypt"],"nullable":true,"type":"string"},"securityPolicy":{"enum":["basic256sha256","aes128_sha256_rsaoaep","aes256_sha256_rsapss"],"nullable":true,"type":"string"}},"required":["publicId","authenticationType"]},{"type":"object","properties":{"publicId":{"enum":["ethernet-ip"],"nullable":false,"type":"string"},"cpu":{"enum":["compactlogix","micro800","micrologix","micrologix800","omron"],"nullable":false,"type":"string"},"rack":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"slot":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"}},"required":["publicId","cpu"]},{"type":"object","properties":{"publicId":{"enum":["host"],"nullable":false,"type":"string"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["bacnet-ip"],"nullable":false,"type":"string"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["mc-protocol"],"nullable":false,"type":"string"},"cpu":{"enum":["FX5U","IQR","L","Q","QNUCPU"],"nullable":true,"type":"string"},"protocol":{"enum":["TCP","UDP"],"nullable":true,"type":"string"},"networkNo":{"maximum":255,"nullable":true,"type":"integer","format":"int32"},"pcNo":{"maxLength":2,"minLength":1,"nullable":true,"pattern":"[A-Za-z0-9]+","type":"string"},"requestDestIoNr":{"maxLength":4,"minLength":1,"nullable":true,"pattern":"[A-Za-z0-9]+","type":"string"},"requestDestModuleStatNr":{"maximum":255,"nullable":true,"type":"integer","format":"int32"},"authenticationType":{"enum":["none","password"],"nullable":true,"type":"string"},"password":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"reconnectDelay":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"maxBlocks":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"maxPoints":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"}},"required":["publicId"]}]},"port":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"pullDelay":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"valuesPerHour":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"mqttTopic":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"mqttBrokerClient":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}}}}},"servers":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"type":{"enum":["http","rdp","rtsp","ssh","vnc","websocket"],"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"port":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"username":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"password":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"hasPassword":{"nullable":false,"type":"boolean"},"authDomain":{"maxLength":253,"minLength":4,"nullable":true,"pattern":".+(\\..[^.]+)","type":"string"},"landingPage":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"connectionQuality":{"enum":["low","normal","high"],"nullable":true,"type":"string"},"readOnly":{"nullable":true,"type":"boolean"},"vncRightClickOnTouchHold":{"nullable":false,"type":"boolean"},"vncEncoding":{"enum":["copyrect","corre","hextile","raw","rre","tight","ultra","ultrazip","zlib","zlibhex","zrle","zywrle"],"nullable":true,"type":"string"},"useSsl":{"nullable":false,"type":"boolean"},"visibleInMobileApp":{"nullable":false,"type":"boolean"},"visibleOnWeb":{"nullable":false,"type":"boolean"},"httpAuthenticationType":{"enum":["ntlm","basic","digest"],"nullable":true,"type":"string"},"recordSessions":{"nullable":true,"type":"boolean"},"audience":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"requireAccessApproval":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"device":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"serviceGroup":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"template":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"type":{"enum":["http","rdp","rtsp","ssh","vnc","websocket"],"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"port":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"username":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"password":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"hasPassword":{"nullable":false,"type":"boolean"},"authDomain":{"maxLength":253,"minLength":4,"nullable":true,"pattern":".+(\\..[^.]+)","type":"string"},"landingPage":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"connectionQuality":{"enum":["low","normal","high"],"nullable":true,"type":"string"},"readOnly":{"nullable":true,"type":"boolean"},"vncRightClickOnTouchHold":{"nullable":false,"type":"boolean"},"vncEncoding":{"enum":["copyrect","corre","hextile","raw","rre","tight","ultra","ultrazip","zlib","zlibhex","zrle","zywrle"],"nullable":true,"type":"string"},"useSsl":{"nullable":false,"type":"boolean"},"visibleInMobileApp":{"nullable":false,"type":"boolean"},"visibleOnWeb":{"nullable":false,"type":"boolean"},"httpAuthenticationType":{"enum":["ntlm","basic","digest"],"nullable":true,"type":"string"},"recordSessions":{"nullable":true,"type":"boolean"},"audience":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"requireAccessApproval":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"}}}}}},"dataSources":{"type":"array","items":{"nullable":false,"type":"object","properties":{"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"continueLoggingOnError":{"nullable":true,"type":"boolean"},"device":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"gracePeriod":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"slug":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"^[a-zA-Z0-9_\\[\\]-]+$","type":"string"},"disabled":{"nullable":false,"type":"boolean"},"protocol":{"oneOf":[{"type":"object","properties":{"publicId":{"enum":["custom"],"nullable":false,"type":"string"},"password":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}},"required":["publicId","password"]},{"type":"object","properties":{"publicId":{"enum":["modbus"],"nullable":false,"type":"string"},"slave":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"format":{"enum":["ABCD","BADC","CDAB","DCBA"],"nullable":true,"type":"string"},"readMode":{"enum":["single_value","consecutive_values","gapped_values"],"nullable":true,"type":"string"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["siemens-step7"],"nullable":false,"type":"string"},"pdu":{"maximum":2147483647,"minimum":-2147483648,"nullable":true,"type":"integer","format":"int32"},"rack":{"maximum":7,"nullable":true,"type":"integer","format":"int32"},"slot":{"maximum":31,"nullable":true,"type":"integer","format":"int32"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["opc-ua"],"nullable":false,"type":"string"},"authenticationType":{"enum":["anonymous","username","certificate"],"nullable":false,"type":"string"},"username":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"password":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"securityMode":{"enum":["sign","signandencrypt"],"nullable":true,"type":"string"},"securityPolicy":{"enum":["basic256sha256","aes128_sha256_rsaoaep","aes256_sha256_rsapss"],"nullable":true,"type":"string"}},"required":["publicId","authenticationType"]},{"type":"object","properties":{"publicId":{"enum":["ethernet-ip"],"nullable":false,"type":"string"},"cpu":{"enum":["compactlogix","micro800","micrologix","micrologix800","omron"],"nullable":false,"type":"string"},"rack":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"slot":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"}},"required":["publicId","cpu"]},{"type":"object","properties":{"publicId":{"enum":["host"],"nullable":false,"type":"string"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["bacnet-ip"],"nullable":false,"type":"string"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["mc-protocol"],"nullable":false,"type":"string"},"cpu":{"enum":["FX5U","IQR","L","Q","QNUCPU"],"nullable":true,"type":"string"},"protocol":{"enum":["TCP","UDP"],"nullable":true,"type":"string"},"networkNo":{"maximum":255,"nullable":true,"type":"integer","format":"int32"},"pcNo":{"maxLength":2,"minLength":1,"nullable":true,"pattern":"[A-Za-z0-9]+","type":"string"},"requestDestIoNr":{"maxLength":4,"minLength":1,"nullable":true,"pattern":"[A-Za-z0-9]+","type":"string"},"requestDestModuleStatNr":{"maximum":255,"nullable":true,"type":"integer","format":"int32"},"authenticationType":{"enum":["none","password"],"nullable":true,"type":"string"},"password":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"reconnectDelay":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"maxBlocks":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"maxPoints":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"}},"required":["publicId"]}]},"port":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"pullDelay":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"valuesPerHour":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"mqttTopic":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"mqttBrokerClient":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}},"pageLinks":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"asset":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"menuItem":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"page":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"audience":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"custom":{"nullable":false,"type":"object"},"default":{"nullable":false,"type":"boolean"},"type":{"enum":["alarm","page","service"],"nullable":true,"type":"string"}}},"group":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"asset":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"menuItem":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"custom":{"nullable":false,"type":"object"}}}},"scheduledAccessRequests":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"user":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"approver":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"approverCompany":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"vpn":{"nullable":false,"type":"boolean"},"servers":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}},"start":{"nullable":false,"type":"string","format":"date-time"},"end":{"nullable":false,"type":"string","format":"date-time"},"status":{"enum":["approved","pending","rejected","revoked"],"nullable":false,"type":"string"},"reason":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"createdOn":{"nullable":false,"type":"string","format":"date-time"},"updatedOn":{"nullable":true,"type":"string","format":"date-time"},"allowedApprovers":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}},"reviewExpiresOn":{"nullable":true,"type":"string","format":"date-time"}}}},"assets":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}},"registrationProfile":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":24,"minLength":24,"nullable":false,"pattern":"(\\d{4}-){4}\\d{4}","type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"agentActivationName":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"}}},"vpnLocked":{"nullable":false,"type":"boolean"},"webAccessLocked":{"nullable":false,"type":"boolean"},"appliedTemplateVersion":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"createdOn":{"nullable":false,"type":"string","format":"date-time"},"createdBy":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"company":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"description":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"agentTemplate":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"number":{"maxLength":64,"minLength":1,"nullable":false,"type":"string"}}}}},"agentServer":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"type":{"enum":["http","rdp","rtsp","ssh","vnc","websocket"],"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"port":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"username":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"password":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"hasPassword":{"nullable":false,"type":"boolean"},"authDomain":{"maxLength":253,"minLength":4,"nullable":true,"pattern":".+(\\..[^.]+)","type":"string"},"landingPage":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"connectionQuality":{"enum":["low","normal","high"],"nullable":true,"type":"string"},"readOnly":{"nullable":true,"type":"boolean"},"vncRightClickOnTouchHold":{"nullable":false,"type":"boolean"},"vncEncoding":{"enum":["copyrect","corre","hextile","raw","rre","tight","ultra","ultrazip","zlib","zlibhex","zrle","zywrle"],"nullable":true,"type":"string"},"useSsl":{"nullable":false,"type":"boolean"},"visibleInMobileApp":{"nullable":false,"type":"boolean"},"visibleOnWeb":{"nullable":false,"type":"boolean"},"httpAuthenticationType":{"enum":["ntlm","basic","digest"],"nullable":true,"type":"string"},"recordSessions":{"nullable":true,"type":"boolean"},"audience":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"requireAccessApproval":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"device":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"serviceGroup":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"template":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"type":{"enum":["http","rdp","rtsp","ssh","vnc","websocket"],"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"port":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"username":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"password":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"hasPassword":{"nullable":false,"type":"boolean"},"authDomain":{"maxLength":253,"minLength":4,"nullable":true,"pattern":".+(\\..[^.]+)","type":"string"},"landingPage":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"connectionQuality":{"enum":["low","normal","high"],"nullable":true,"type":"string"},"readOnly":{"nullable":true,"type":"boolean"},"vncRightClickOnTouchHold":{"nullable":false,"type":"boolean"},"vncEncoding":{"enum":["copyrect","corre","hextile","raw","rre","tight","ultra","ultrazip","zlib","zlibhex","zrle","zywrle"],"nullable":true,"type":"string"},"useSsl":{"nullable":false,"type":"boolean"},"visibleInMobileApp":{"nullable":false,"type":"boolean"},"visibleOnWeb":{"nullable":false,"type":"boolean"},"httpAuthenticationType":{"enum":["ntlm","basic","digest"],"nullable":true,"type":"string"},"recordSessions":{"nullable":true,"type":"boolean"},"audience":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"requireAccessApproval":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"}}}}},"closeReason":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"closedOn":{"nullable":true,"type":"string","format":"date-time"},"expiresOn":{"nullable":false,"type":"string","format":"date-time"}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/web-accesses":{"get":{"tags":["WebAccessList"],"summary":"WebAccessList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":50,"minLength":1,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"deviceId":{"maxLength":128,"minLength":1,"nullable":false,"type":"string"},"type":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"additionalSubnets":{"nullable":false,"type":"boolean"},"allowDataPublishing":{"nullable":false,"type":"boolean"},"allowDemoDevice":{"nullable":false,"type":"boolean"},"allowTemplating":{"nullable":false,"type":"boolean"},"allowReboot":{"nullable":false,"type":"boolean"},"configPush":{"nullable":false,"type":"boolean"},"configFileFormat":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"customServers":{"nullable":false,"type":"boolean"},"deviceIdFormat":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"httpProxyPort":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"latestFirmwareFile":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"code":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"notes":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"agentType":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"type":{"enum":["firmware"],"nullable":false,"type":"string"},"latest":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"offlineConfiguration":{"nullable":false,"type":"boolean"},"openvpnConfigMultiUse":{"nullable":false,"type":"boolean"},"purchasePrice":{"nullable":false,"type":"object","properties":{"gratis":{"nullable":false,"type":"boolean"}}},"router":{"nullable":false,"type":"boolean"},"stunnelSupport":{"nullable":false,"type":"boolean"},"wanPortForwardings":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"},"hasSecondWanPort":{"nullable":false,"type":"boolean"}}},"location":{"nullable":true,"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"latitude":{"nullable":false,"type":"string"},"longitude":{"nullable":false,"type":"string"}}},"geoLocation":{"nullable":true,"type":"object","properties":{"latitude":{"nullable":false,"type":"string"},"longitude":{"nullable":false,"type":"string"},"country":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"city":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"timeZone":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"custom":{"nullable":false,"type":"object"},"description":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"useStunnel":{"nullable":false,"type":"boolean"},"preferLocationOverGeoip":{"nullable":false,"type":"boolean"},"reRegistration":{"nullable":false,"type":"boolean"},"replaceRegistration":{"nullable":false,"type":"boolean"},"replaceMacAddress":{"maxLength":17,"minLength":0,"nullable":true,"pattern":"[0-9a-fA-F]{2}(:[0-9a-fA-F]{2}){5}","type":"string"},"fixedVpnAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"macAddress":{"maxLength":17,"minLength":1,"nullable":false,"type":"string"},"serialNumber":{"maxLength":128,"minLength":1,"nullable":false,"type":"string"},"pullCodeGeneratedOn":{"nullable":true,"type":"string","format":"date-time"},"controlKeyGeneratedOn":{"nullable":true,"type":"string","format":"date-time"},"lastSeenAgentUserAgent":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"value":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"configName":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"configVersion":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"hardware":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"hardwareCode":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"hardwareVersion":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"firmwareVersion":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"osName":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"osVersion":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"appName":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"appVersion":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"packageName":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"packageVersion":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"libixagentVersion":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"libixloggerVersion":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"logOnTrigger":{"nullable":false,"type":"boolean"},"alarming":{"nullable":false,"type":"boolean"},"dataMonitoring":{"nullable":false,"type":"boolean"},"wifi":{"nullable":false,"type":"boolean"},"remoteFirmwareUpgrade":{"nullable":false,"type":"boolean"},"staticMapping":{"nullable":false,"type":"boolean"},"stewardConfigPush":{"nullable":false,"type":"boolean"},"wanInterfaceEth0":{"nullable":false,"type":"boolean"},"wanInterfaceWifi0":{"nullable":false,"type":"boolean"},"wanInterfaceCell0":{"enum":["3G","4G","neither"],"nullable":false,"type":"string"},"multiWan":{"nullable":false,"type":"boolean"},"openvpnVersion":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"openvpnOccEnabled":{"nullable":false,"type":"boolean"},"openvpnOpensslVersion":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"}}},"networkValues":{"type":"array","items":{"nullable":false,"type":"object","properties":{"interface":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"value":{"type":"array","items":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}}}}},"networkReportedOn":{"nullable":true,"type":"string","format":"date-time"},"activeStatus":{"enum":["active","inactive"],"nullable":false,"type":"string"},"activationLicence":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"type":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"usageType":{"enum":["advanced-user-management","agent-registration-profile","agent-templates","alarming","api-integrations","app-engine-level-1","app-engine-level-2","app-engine-level-3","asset-management","card-view","connection-monitoring","controlled-devices","custom-branding","custom-domain","custom-fields","custom-legal","custom-legal-legacy","custom-sso","edge-app-management","ixagent","landing-page","live-data","logging","m2m-cloud-cluster","main-pages","mobile-app","mqtt-device","object-storage","premium-branding","rdp","remote-access","reporting","request-access","rtsp","scim","session-recording","sla","ssh","subgroups","temporary-access","vpn-access-rule","vpn-usage"],"nullable":false,"type":"string"},"companyLimit":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"scope":{"enum":["agent","company"],"nullable":false,"type":"string"}}},"serialNumber":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"expiresOn":{"nullable":true,"type":"string","format":"date-time"},"activated":{"nullable":false,"type":"boolean"},"trial":{"nullable":false,"type":"boolean"},"value":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"locked":{"nullable":true,"type":"boolean"},"maxRetentionPolicy":{"maxLength":255,"minLength":2,"nullable":true,"type":"string"},"bundle":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}},"pendingRegistration":{"nullable":false,"type":"boolean"},"card":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"activeVpnSession":{"nullable":true,"type":"object","properties":{"rscServer":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"vpnRange":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"supportedLayers":{"type":"array","items":{"enum":["tun","tap"],"nullable":false,"type":"string"}},"location":{"nullable":false,"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"latitude":{"nullable":false,"type":"string"},"longitude":{"nullable":false,"type":"string"}}}}},"startedOn":{"nullable":false,"type":"string","format":"date-time"},"sessionName":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"vpnAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"closed":{"nullable":false,"type":"boolean"}}},"vpnChangedOn":{"nullable":true,"type":"string","format":"date-time"},"mdrServer":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"mqttChangedOn":{"nullable":true,"type":"string","format":"date-time"},"loggingMdrServer":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"loggingMqttChangedOn":{"nullable":true,"type":"string","format":"date-time"},"lsiServer":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"company":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":24,"minLength":24,"nullable":false,"pattern":"(\\d{4}-){4}\\d{4}","type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"controlledBy":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":24,"minLength":24,"nullable":false,"pattern":"(\\d{4}-){4}\\d{4}","type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"vpnAudience":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"custom":{"nullable":false,"type":"object"},"default":{"nullable":false,"type":"boolean"},"type":{"enum":["alarm","page","service"],"nullable":true,"type":"string"}}},"vpnRequireAccessApproval":{"nullable":false,"type":"boolean"},"vpnAccessRules":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"audience":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"ipAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"netMask":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}}}},"vpnVisibleInMobileApp":{"nullable":false,"type":"boolean"},"vpnVisibleOnWeb":{"nullable":false,"type":"boolean"},"dataAudience":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"custom":{"nullable":false,"type":"object"},"default":{"nullable":false,"type":"boolean"},"type":{"enum":["alarm","page","service"],"nullable":true,"type":"string"}}},"memberships":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"group":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}},"rateLimiting":{"nullable":false,"type":"object","properties":{"configMqttCommandLimit":{"enum":["soft","hard","lock"],"nullable":true,"type":"string"},"configMqttCommandCounter":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"configMqttCommandLastHit":{"nullable":true,"type":"string","format":"date-time"},"configMqttDataLimit":{"enum":["soft","hard","lock"],"nullable":true,"type":"string"},"configMqttDataCounter":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"configMqttDataLastHit":{"nullable":true,"type":"string","format":"date-time"},"configOpenvpnLimit":{"enum":["soft","hard","lock"],"nullable":true,"type":"string"},"configOpenvpnCounter":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"configOpenvpnLastHit":{"nullable":true,"type":"string","format":"date-time"}}},"vpnProtocol":{"enum":["udp","tcp"],"nullable":false,"type":"string"},"config":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"configFileServer":{"maxLength":4294967295,"minLength":0,"nullable":true,"type":"string"},"configPushedOn":{"nullable":true,"type":"string","format":"date-time"},"configFileReported":{"maxLength":4294967295,"minLength":0,"nullable":true,"type":"string"},"configFileReportedWlanKeyEnabled":{"nullable":false,"type":"boolean"},"configFileReportedCellularPasswordEnabled":{"nullable":false,"type":"boolean"},"configReportedOn":{"nullable":true,"type":"string","format":"date-time"},"differentConfigs":{"nullable":false,"type":"boolean"},"differentWanConfigs":{"nullable":false,"type":"boolean"},"stewardConfigFileServer":{"maxLength":4294967295,"minLength":0,"nullable":true,"type":"string"},"stewardConfigFileReported":{"maxLength":4294967295,"minLength":0,"nullable":true,"type":"string"},"stewardConfigReportedOn":{"nullable":true,"type":"string","format":"date-time"},"differentStewardConfigs":{"nullable":false,"type":"boolean"},"routerLan":{"nullable":false,"type":"object","properties":{"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"ipAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"netMask":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"network":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"dhcpServerEnabled":{"nullable":false,"type":"boolean"},"dhcpServerRangeFrom":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"dhcpServerRangeTo":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"gatewayLessRouting":{"nullable":false,"type":"boolean"},"forwardLanWan":{"enum":["neither","public","private","both"],"nullable":false,"type":"string"},"forwardLanWan2":{"enum":["neither","public","private","both"],"nullable":false,"type":"string"},"wlanEnable":{"nullable":true,"type":"boolean"},"wlanSsid":{"maxLength":32,"minLength":0,"nullable":true,"type":"string"},"wlanKey":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"wlanChannel":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"bacnetBbmd":{"type":"array","items":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}},"udpBroadcastRelayPort":{"type":"array","items":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"}}}},"routerVpn":{"nullable":false,"type":"object","properties":{"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"sourceNatEnabled":{"nullable":false,"type":"boolean"}}},"routerWan":{"nullable":false,"type":"object","properties":{"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"multiwanPolicy":{"enum":["eth_cell_wifi","cell_eth_wifi","eth_wifi_cell","wifi_eth_cell","cell_wifi_eth","wifi_cell_eth"],"nullable":true,"type":"string"},"ipUseDhcp":{"nullable":true,"type":"boolean"},"ipAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"ipGateway":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"ipNetMask":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"dnsServers":{"type":"array","items":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}},"dnsRebindProtectionEnabled":{"nullable":true,"type":"boolean"},"cellularApn":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"cellularPincode":{"maxLength":8,"minLength":0,"nullable":true,"type":"string"},"cellularMtu":{"maximum":1500,"minimum":576,"nullable":true,"type":"integer","format":"int32"},"digitalInputMode":{"enum":["disable_vpn_high","disable_vpn_low","disable_wan_high","disable_wan_low"],"nullable":true,"type":"string"},"wanTrackInterval":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"wanTrackIps":{"type":"array","items":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}},"wlanTrackInterval":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"wlanTrackIps":{"type":"array","items":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}},"cellularTrackInterval":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"cellularTrackIps":{"type":"array","items":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}},"httpProxyAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"httpProxyPort":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"httpProxyAuthentication":{"enum":["none","basic","ntlm"],"nullable":true,"type":"string"},"httpProxyUsername":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"httpProxyIsSocks5":{"nullable":true,"type":"boolean"},"wlanSsid":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"wlanIpUseDhcp":{"nullable":true,"type":"boolean"},"wlanIpAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"wlanIpGateway":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"wlanIpNetMask":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"wlanDnsServers":{"type":"array","items":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}},"cellularUsername":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"}}},"routerDisplay":{"nullable":false,"type":"object","properties":{"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"lockEnabled":{"nullable":false,"type":"boolean"},"lockCode":{"maxLength":4,"minLength":4,"nullable":true,"pattern":"[0-9]+","type":"string"}}},"routerAdditionalSubnets":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"networkAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"networkMask":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"gatewayAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}},"routerPortForwards":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"interface":{"enum":["VPN","WAN","WAN2"],"nullable":false,"type":"string"},"targetIpAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"targetPort":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"externalPort":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}},"routerNtpServers":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"server":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}}},"demoDevice":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"expiresOn":{"nullable":false,"type":"string","format":"date-time"},"agentType":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"additionalSubnets":{"nullable":false,"type":"boolean"},"allowDataPublishing":{"nullable":false,"type":"boolean"},"allowDemoDevice":{"nullable":false,"type":"boolean"},"allowTemplating":{"nullable":false,"type":"boolean"},"allowReboot":{"nullable":false,"type":"boolean"},"configPush":{"nullable":false,"type":"boolean"},"configFileFormat":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"customServers":{"nullable":false,"type":"boolean"},"deviceIdFormat":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"httpProxyPort":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"latestFirmwareFile":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"code":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"notes":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"agentType":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"type":{"enum":["firmware"],"nullable":false,"type":"string"},"latest":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"offlineConfiguration":{"nullable":false,"type":"boolean"},"openvpnConfigMultiUse":{"nullable":false,"type":"boolean"},"purchasePrice":{"nullable":false,"type":"object","properties":{"gratis":{"nullable":false,"type":"boolean"}}},"router":{"nullable":false,"type":"boolean"},"stunnelSupport":{"nullable":false,"type":"boolean"},"wanPortForwardings":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"},"hasSecondWanPort":{"nullable":false,"type":"boolean"}}},"dmvServer":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}},"connectedUsers":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}},"loggingApp":{"nullable":false,"type":"object","properties":{"licence":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"type":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"usageType":{"enum":["advanced-user-management","agent-registration-profile","agent-templates","alarming","api-integrations","app-engine-level-1","app-engine-level-2","app-engine-level-3","asset-management","card-view","connection-monitoring","controlled-devices","custom-branding","custom-domain","custom-fields","custom-legal","custom-legal-legacy","custom-sso","edge-app-management","ixagent","landing-page","live-data","logging","m2m-cloud-cluster","main-pages","mobile-app","mqtt-device","object-storage","premium-branding","rdp","remote-access","reporting","request-access","rtsp","scim","session-recording","sla","ssh","subgroups","temporary-access","vpn-access-rule","vpn-usage"],"nullable":false,"type":"string"},"companyLimit":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"scope":{"enum":["agent","company"],"nullable":false,"type":"string"}}},"serialNumber":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"expiresOn":{"nullable":true,"type":"string","format":"date-time"},"activated":{"nullable":false,"type":"boolean"},"trial":{"nullable":false,"type":"boolean"},"value":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"locked":{"nullable":true,"type":"boolean"},"maxRetentionPolicy":{"maxLength":255,"minLength":2,"nullable":true,"type":"string"},"agent":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"deviceId":{"maxLength":128,"minLength":1,"nullable":false,"type":"string"},"type":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"location":{"nullable":false,"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"latitude":{"nullable":false,"type":"string"},"longitude":{"nullable":false,"type":"string"}}},"geoLocation":{"nullable":false,"type":"object","properties":{"latitude":{"nullable":false,"type":"string"},"longitude":{"nullable":false,"type":"string"},"country":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"city":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"custom":{"nullable":false,"type":"object"}}},"hasAgent":{"nullable":false,"type":"boolean"},"agentType":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"additionalSubnets":{"nullable":false,"type":"boolean"},"allowDataPublishing":{"nullable":false,"type":"boolean"},"allowDemoDevice":{"nullable":false,"type":"boolean"},"allowTemplating":{"nullable":false,"type":"boolean"},"allowReboot":{"nullable":false,"type":"boolean"},"configPush":{"nullable":false,"type":"boolean"},"configFileFormat":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"customServers":{"nullable":false,"type":"boolean"},"deviceIdFormat":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"httpProxyPort":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"latestFirmwareFile":{"nullable":false,"type":"object"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"offlineConfiguration":{"nullable":false,"type":"boolean"},"openvpnConfigMultiUse":{"nullable":false,"type":"boolean"},"purchasePrice":{"nullable":false,"type":"object"},"router":{"nullable":false,"type":"boolean"},"stunnelSupport":{"nullable":false,"type":"boolean"},"wanPortForwardings":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"},"hasSecondWanPort":{"nullable":false,"type":"boolean"}}},"bundle":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}},"enabled":{"nullable":false,"type":"boolean"}}},"valuesPerHour":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"alarmingApp":{"nullable":false,"type":"object","properties":{"licence":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"type":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"usageType":{"enum":["advanced-user-management","agent-registration-profile","agent-templates","alarming","api-integrations","app-engine-level-1","app-engine-level-2","app-engine-level-3","asset-management","card-view","connection-monitoring","controlled-devices","custom-branding","custom-domain","custom-fields","custom-legal","custom-legal-legacy","custom-sso","edge-app-management","ixagent","landing-page","live-data","logging","m2m-cloud-cluster","main-pages","mobile-app","mqtt-device","object-storage","premium-branding","rdp","remote-access","reporting","request-access","rtsp","scim","session-recording","sla","ssh","subgroups","temporary-access","vpn-access-rule","vpn-usage"],"nullable":false,"type":"string"},"companyLimit":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"scope":{"enum":["agent","company"],"nullable":false,"type":"string"}}},"serialNumber":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"expiresOn":{"nullable":true,"type":"string","format":"date-time"},"activated":{"nullable":false,"type":"boolean"},"trial":{"nullable":false,"type":"boolean"},"value":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"locked":{"nullable":true,"type":"boolean"},"maxRetentionPolicy":{"maxLength":255,"minLength":2,"nullable":true,"type":"string"},"agent":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"deviceId":{"maxLength":128,"minLength":1,"nullable":false,"type":"string"},"type":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"location":{"nullable":false,"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"latitude":{"nullable":false,"type":"string"},"longitude":{"nullable":false,"type":"string"}}},"geoLocation":{"nullable":false,"type":"object","properties":{"latitude":{"nullable":false,"type":"string"},"longitude":{"nullable":false,"type":"string"},"country":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"city":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"custom":{"nullable":false,"type":"object"}}},"hasAgent":{"nullable":false,"type":"boolean"},"agentType":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"additionalSubnets":{"nullable":false,"type":"boolean"},"allowDataPublishing":{"nullable":false,"type":"boolean"},"allowDemoDevice":{"nullable":false,"type":"boolean"},"allowTemplating":{"nullable":false,"type":"boolean"},"allowReboot":{"nullable":false,"type":"boolean"},"configPush":{"nullable":false,"type":"boolean"},"configFileFormat":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"customServers":{"nullable":false,"type":"boolean"},"deviceIdFormat":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"httpProxyPort":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"latestFirmwareFile":{"nullable":false,"type":"object"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"offlineConfiguration":{"nullable":false,"type":"boolean"},"openvpnConfigMultiUse":{"nullable":false,"type":"boolean"},"purchasePrice":{"nullable":false,"type":"object"},"router":{"nullable":false,"type":"boolean"},"stunnelSupport":{"nullable":false,"type":"boolean"},"wanPortForwardings":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"},"hasSecondWanPort":{"nullable":false,"type":"boolean"}}},"bundle":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}}},"enabled":{"nullable":false,"type":"boolean"}}},"lanWanAccessRules":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"sourceIpAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"sourceMacAddress":{"maxLength":17,"minLength":17,"nullable":true,"pattern":"[0-9a-fA-F]{2}(:[0-9a-fA-F]{2}){5}","type":"string"},"destinationPort":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"destinationIpAddress":{"maxLength":19,"minLength":7,"nullable":true,"pattern":"\\d{1,3}(\\.\\d{1,3}){3}(\\/\\d{1,3})?","type":"string"},"protocol":{"enum":["all","tcp","udp","icmp","ah","ax.25","dccp","ddp","egp","eigrp","encap","esp","etherip","fc","ggp","gre","hmp","idpr-cmtp","idrp","igmp","igp","ipcomp","ipencap","ipip","ipv6","ipv6-frag","ipv6-icmp","ipv6-nonxt","ipv6-opts","ipv6-route","isis","iso-tp4","l2tp","ospf","pim","pup","rdp","rspf","rsvp","sctp","skip","st","vmtp","vrrp","xns-idp","xtp"],"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"}}}},"oneToOneNatRules":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"type":{"enum":["wan","wlan","vpn"],"nullable":false,"type":"string"},"virtualIpAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"destinationIpAddress":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"},"protocol":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"port":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"sourceIpAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"}}}},"devices":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"ipAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"macAddress":{"maxLength":17,"minLength":17,"nullable":true,"pattern":"[0-9a-fA-F]{2}(:[0-9a-fA-F]{2}){5}","type":"string"},"customAddress":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"dataSources":{"type":"array","items":{"nullable":false,"type":"object","properties":{"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"continueLoggingOnError":{"nullable":true,"type":"boolean"},"device":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"gracePeriod":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"slug":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"^[a-zA-Z0-9_\\[\\]-]+$","type":"string"},"disabled":{"nullable":false,"type":"boolean"},"protocol":{"oneOf":[{"type":"object","properties":{"publicId":{"enum":["custom"],"nullable":false,"type":"string"},"password":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}},"required":["publicId","password"]},{"type":"object","properties":{"publicId":{"enum":["modbus"],"nullable":false,"type":"string"},"slave":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"format":{"enum":["ABCD","BADC","CDAB","DCBA"],"nullable":true,"type":"string"},"readMode":{"enum":["single_value","consecutive_values","gapped_values"],"nullable":true,"type":"string"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["siemens-step7"],"nullable":false,"type":"string"},"pdu":{"maximum":2147483647,"minimum":-2147483648,"nullable":true,"type":"integer","format":"int32"},"rack":{"maximum":7,"nullable":true,"type":"integer","format":"int32"},"slot":{"maximum":31,"nullable":true,"type":"integer","format":"int32"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["opc-ua"],"nullable":false,"type":"string"},"authenticationType":{"enum":["anonymous","username","certificate"],"nullable":false,"type":"string"},"username":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"password":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"securityMode":{"enum":["sign","signandencrypt"],"nullable":true,"type":"string"},"securityPolicy":{"enum":["basic256sha256","aes128_sha256_rsaoaep","aes256_sha256_rsapss"],"nullable":true,"type":"string"}},"required":["publicId","authenticationType"]},{"type":"object","properties":{"publicId":{"enum":["ethernet-ip"],"nullable":false,"type":"string"},"cpu":{"enum":["compactlogix","micro800","micrologix","micrologix800","omron"],"nullable":false,"type":"string"},"rack":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"slot":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"}},"required":["publicId","cpu"]},{"type":"object","properties":{"publicId":{"enum":["host"],"nullable":false,"type":"string"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["bacnet-ip"],"nullable":false,"type":"string"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["mc-protocol"],"nullable":false,"type":"string"},"cpu":{"enum":["FX5U","IQR","L","Q","QNUCPU"],"nullable":true,"type":"string"},"protocol":{"enum":["TCP","UDP"],"nullable":true,"type":"string"},"networkNo":{"maximum":255,"nullable":true,"type":"integer","format":"int32"},"pcNo":{"maxLength":2,"minLength":1,"nullable":true,"pattern":"[A-Za-z0-9]+","type":"string"},"requestDestIoNr":{"maxLength":4,"minLength":1,"nullable":true,"pattern":"[A-Za-z0-9]+","type":"string"},"requestDestModuleStatNr":{"maximum":255,"nullable":true,"type":"integer","format":"int32"},"authenticationType":{"enum":["none","password"],"nullable":true,"type":"string"},"password":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"reconnectDelay":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"maxBlocks":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"maxPoints":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"}},"required":["publicId"]}]},"port":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"pullDelay":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"valuesPerHour":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"mqttTopic":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"mqttBrokerClient":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}}}}},"servers":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"type":{"enum":["http","rdp","rtsp","ssh","vnc","websocket"],"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"port":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"username":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"password":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"hasPassword":{"nullable":false,"type":"boolean"},"authDomain":{"maxLength":253,"minLength":4,"nullable":true,"pattern":".+(\\..[^.]+)","type":"string"},"landingPage":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"connectionQuality":{"enum":["low","normal","high"],"nullable":true,"type":"string"},"readOnly":{"nullable":true,"type":"boolean"},"vncRightClickOnTouchHold":{"nullable":false,"type":"boolean"},"vncEncoding":{"enum":["copyrect","corre","hextile","raw","rre","tight","ultra","ultrazip","zlib","zlibhex","zrle","zywrle"],"nullable":true,"type":"string"},"useSsl":{"nullable":false,"type":"boolean"},"visibleInMobileApp":{"nullable":false,"type":"boolean"},"visibleOnWeb":{"nullable":false,"type":"boolean"},"httpAuthenticationType":{"enum":["ntlm","basic","digest"],"nullable":true,"type":"string"},"recordSessions":{"nullable":true,"type":"boolean"},"audience":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"requireAccessApproval":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"device":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"serviceGroup":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"template":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"type":{"enum":["http","rdp","rtsp","ssh","vnc","websocket"],"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"port":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"username":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"password":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"hasPassword":{"nullable":false,"type":"boolean"},"authDomain":{"maxLength":253,"minLength":4,"nullable":true,"pattern":".+(\\..[^.]+)","type":"string"},"landingPage":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"connectionQuality":{"enum":["low","normal","high"],"nullable":true,"type":"string"},"readOnly":{"nullable":true,"type":"boolean"},"vncRightClickOnTouchHold":{"nullable":false,"type":"boolean"},"vncEncoding":{"enum":["copyrect","corre","hextile","raw","rre","tight","ultra","ultrazip","zlib","zlibhex","zrle","zywrle"],"nullable":true,"type":"string"},"useSsl":{"nullable":false,"type":"boolean"},"visibleInMobileApp":{"nullable":false,"type":"boolean"},"visibleOnWeb":{"nullable":false,"type":"boolean"},"httpAuthenticationType":{"enum":["ntlm","basic","digest"],"nullable":true,"type":"string"},"recordSessions":{"nullable":true,"type":"boolean"},"audience":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"requireAccessApproval":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"}}}}}},"dataSources":{"type":"array","items":{"nullable":false,"type":"object","properties":{"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"continueLoggingOnError":{"nullable":true,"type":"boolean"},"device":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"gracePeriod":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"slug":{"maxLength":64,"minLength":1,"nullable":false,"pattern":"^[a-zA-Z0-9_\\[\\]-]+$","type":"string"},"disabled":{"nullable":false,"type":"boolean"},"protocol":{"oneOf":[{"type":"object","properties":{"publicId":{"enum":["custom"],"nullable":false,"type":"string"},"password":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}},"required":["publicId","password"]},{"type":"object","properties":{"publicId":{"enum":["modbus"],"nullable":false,"type":"string"},"slave":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"format":{"enum":["ABCD","BADC","CDAB","DCBA"],"nullable":true,"type":"string"},"readMode":{"enum":["single_value","consecutive_values","gapped_values"],"nullable":true,"type":"string"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["siemens-step7"],"nullable":false,"type":"string"},"pdu":{"maximum":2147483647,"minimum":-2147483648,"nullable":true,"type":"integer","format":"int32"},"rack":{"maximum":7,"nullable":true,"type":"integer","format":"int32"},"slot":{"maximum":31,"nullable":true,"type":"integer","format":"int32"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["opc-ua"],"nullable":false,"type":"string"},"authenticationType":{"enum":["anonymous","username","certificate"],"nullable":false,"type":"string"},"username":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"password":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"securityMode":{"enum":["sign","signandencrypt"],"nullable":true,"type":"string"},"securityPolicy":{"enum":["basic256sha256","aes128_sha256_rsaoaep","aes256_sha256_rsapss"],"nullable":true,"type":"string"}},"required":["publicId","authenticationType"]},{"type":"object","properties":{"publicId":{"enum":["ethernet-ip"],"nullable":false,"type":"string"},"cpu":{"enum":["compactlogix","micro800","micrologix","micrologix800","omron"],"nullable":false,"type":"string"},"rack":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"slot":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"}},"required":["publicId","cpu"]},{"type":"object","properties":{"publicId":{"enum":["host"],"nullable":false,"type":"string"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["bacnet-ip"],"nullable":false,"type":"string"}},"required":["publicId"]},{"type":"object","properties":{"publicId":{"enum":["mc-protocol"],"nullable":false,"type":"string"},"cpu":{"enum":["FX5U","IQR","L","Q","QNUCPU"],"nullable":true,"type":"string"},"protocol":{"enum":["TCP","UDP"],"nullable":true,"type":"string"},"networkNo":{"maximum":255,"nullable":true,"type":"integer","format":"int32"},"pcNo":{"maxLength":2,"minLength":1,"nullable":true,"pattern":"[A-Za-z0-9]+","type":"string"},"requestDestIoNr":{"maxLength":4,"minLength":1,"nullable":true,"pattern":"[A-Za-z0-9]+","type":"string"},"requestDestModuleStatNr":{"maximum":255,"nullable":true,"type":"integer","format":"int32"},"authenticationType":{"enum":["none","password"],"nullable":true,"type":"string"},"password":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"reconnectDelay":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"maxBlocks":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"maxPoints":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"}},"required":["publicId"]}]},"port":{"maximum":65535,"nullable":true,"type":"integer","format":"int32"},"pullDelay":{"maximum":4294967295,"nullable":true,"type":"integer","format":"int32"},"valuesPerHour":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"mqttTopic":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"mqttBrokerClient":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}},"pageLinks":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"asset":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"menuItem":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"page":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"audience":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"description":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"custom":{"nullable":false,"type":"object"},"default":{"nullable":false,"type":"boolean"},"type":{"enum":["alarm","page","service"],"nullable":true,"type":"string"}}},"group":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"asset":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"menuItem":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"order":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"custom":{"nullable":false,"type":"object"}}}},"scheduledAccessRequests":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"user":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"approver":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"approverCompany":{"nullable":true,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"vpn":{"nullable":false,"type":"boolean"},"servers":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}},"start":{"nullable":false,"type":"string","format":"date-time"},"end":{"nullable":false,"type":"string","format":"date-time"},"status":{"enum":["approved","pending","rejected","revoked"],"nullable":false,"type":"string"},"reason":{"maxLength":65535,"minLength":0,"nullable":false,"type":"string"},"createdOn":{"nullable":false,"type":"string","format":"date-time"},"updatedOn":{"nullable":true,"type":"string","format":"date-time"},"allowedApprovers":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}}},"reviewExpiresOn":{"nullable":true,"type":"string","format":"date-time"}}}},"assets":{"type":"array","items":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}},"registrationProfile":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":24,"minLength":24,"nullable":false,"pattern":"(\\d{4}-){4}\\d{4}","type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"agentActivationName":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"}}},"vpnLocked":{"nullable":false,"type":"boolean"},"webAccessLocked":{"nullable":false,"type":"boolean"},"appliedTemplateVersion":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"createdOn":{"nullable":false,"type":"string","format":"date-time"},"createdBy":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"}}},"company":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"description":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"},"agentTemplate":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"number":{"maxLength":64,"minLength":1,"nullable":false,"type":"string"}}}}},"agentServer":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"type":{"enum":["http","rdp","rtsp","ssh","vnc","websocket"],"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"port":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"username":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"password":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"hasPassword":{"nullable":false,"type":"boolean"},"authDomain":{"maxLength":253,"minLength":4,"nullable":true,"pattern":".+(\\..[^.]+)","type":"string"},"landingPage":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"connectionQuality":{"enum":["low","normal","high"],"nullable":true,"type":"string"},"readOnly":{"nullable":true,"type":"boolean"},"vncRightClickOnTouchHold":{"nullable":false,"type":"boolean"},"vncEncoding":{"enum":["copyrect","corre","hextile","raw","rre","tight","ultra","ultrazip","zlib","zlibhex","zrle","zywrle"],"nullable":true,"type":"string"},"useSsl":{"nullable":false,"type":"boolean"},"visibleInMobileApp":{"nullable":false,"type":"boolean"},"visibleOnWeb":{"nullable":false,"type":"boolean"},"httpAuthenticationType":{"enum":["ntlm","basic","digest"],"nullable":true,"type":"string"},"recordSessions":{"nullable":true,"type":"boolean"},"audience":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"requireAccessApproval":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"},"agent":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"device":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"serviceGroup":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"template":{"nullable":true,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"type":{"enum":["http","rdp","rtsp","ssh","vnc","websocket"],"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"port":{"maximum":65535,"nullable":false,"type":"integer","format":"int32"},"username":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"password":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"hasPassword":{"nullable":false,"type":"boolean"},"authDomain":{"maxLength":253,"minLength":4,"nullable":true,"pattern":".+(\\..[^.]+)","type":"string"},"landingPage":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"connectionQuality":{"enum":["low","normal","high"],"nullable":true,"type":"string"},"readOnly":{"nullable":true,"type":"boolean"},"vncRightClickOnTouchHold":{"nullable":false,"type":"boolean"},"vncEncoding":{"enum":["copyrect","corre","hextile","raw","rre","tight","ultra","ultrazip","zlib","zlibhex","zrle","zywrle"],"nullable":true,"type":"string"},"useSsl":{"nullable":false,"type":"boolean"},"visibleInMobileApp":{"nullable":false,"type":"boolean"},"visibleOnWeb":{"nullable":false,"type":"boolean"},"httpAuthenticationType":{"enum":["ntlm","basic","digest"],"nullable":true,"type":"string"},"recordSessions":{"nullable":true,"type":"boolean"},"audience":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}},"requireAccessApproval":{"nullable":false,"type":"boolean"},"custom":{"nullable":false,"type":"object"}}}}},"closeReason":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"closedOn":{"nullable":true,"type":"string","format":"date-time"},"expiresOn":{"nullable":false,"type":"string","format":"date-time"}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"}],"security":[{"bearerToken":[]}]},"post":{"tags":["WebAccessList"],"summary":"WebAccessList","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":50,"minLength":1,"nullable":false,"type":"string"},"url":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}},"required":["publicId","url"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"server":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}},"required":["server"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/web-access/session-recordings/{publicId}":{"get":{"tags":["WebaccessSessionRecording"],"summary":"WebaccessSessionRecording","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agentName":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"agentServerName":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"agentServerType":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"userName":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"status":{"enum":["processing","succeeded","failed"],"nullable":false,"type":"string"},"startTime":{"nullable":false,"type":"string","format":"date-time"},"duration":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"error":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/web-access/session-recordings/{publicId}/download":{"get":{"tags":["WebaccessSessionRecordingDownload"],"summary":"WebaccessSessionRecordingDownload","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"url":{"maxLength":255,"minLength":0,"nullable":false,"type":"string"}},"required":["url"]}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/web-access/session-recordings":{"get":{"tags":["WebaccessSessionRecordingList"],"summary":"WebaccessSessionRecordingList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"agentName":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"agentServerName":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"agentServerType":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"userName":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"status":{"enum":["processing","succeeded","failed"],"nullable":false,"type":"string"},"startTime":{"nullable":false,"type":"string","format":"date-time"},"duration":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"error":{"maxLength":65535,"minLength":0,"nullable":true,"type":"string"}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiCompany"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"}],"security":[{"bearerToken":[]}]}},"/webhook-subscriptions/{publicId}":{"get":{"tags":["WebhookSubscription"],"summary":"WebhookSubscription","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"nullable":false,"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"createdOn":{"nullable":false,"type":"string","format":"date-time"},"callbackUrl":{"maxLength":2048,"minLength":0,"nullable":false,"type":"string"},"timeout":{"maximum":8000,"minimum":1,"nullable":false,"type":"integer","format":"int32"}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]},"patch":{"tags":["WebhookSubscription"],"summary":"WebhookSubscription","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"timeout":{"maximum":8000,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"callbackUrl":{"maxLength":2048,"minLength":0,"nullable":false,"type":"string"}}}}}},"security":[{"bearerToken":[]}]},"delete":{"tags":["WebhookSubscription"],"summary":"WebhookSubscription","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}},"/webhook-subscriptions":{"get":{"tags":["WebhookSubscriptionList"],"summary":"WebhookSubscriptionList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"createdOn":{"nullable":false,"type":"string","format":"date-time"},"callbackUrl":{"maxLength":2048,"minLength":0,"nullable":false,"type":"string"},"timeout":{"maximum":8000,"minimum":1,"nullable":false,"type":"integer","format":"int32"}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"}],"security":[{"bearerToken":[]}]},"post":{"tags":["WebhookSubscriptionList"],"summary":"WebhookSubscriptionList","responses":{"201":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"timeout":{"maximum":8000,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"callbackUrl":{"maxLength":2048,"minLength":0,"nullable":false,"type":"string"}},"required":["name","callbackUrl"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"patch":{"tags":["WebhookSubscriptionList"],"summary":"WebhookSubscriptionList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"},"name":{"maxLength":255,"minLength":1,"nullable":false,"type":"string"},"timeout":{"maximum":8000,"minimum":1,"nullable":false,"type":"integer","format":"int32"},"callbackUrl":{"maxLength":2048,"minLength":0,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]},"delete":{"tags":["WebhookSubscriptionList"],"summary":"WebhookSubscriptionList","responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"data":{"type":"object","nullable":true}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":12,"minLength":12,"nullable":false,"type":"string"}},"required":["publicId"]}}}},"description":"You can give one item or a list of items"},"security":[{"bearerToken":[]}]}},"/webhook-subscriptions/{publicId}/triggers":{"get":{"tags":["WebhookSubscriptionTriggerList"],"summary":"WebhookSubscriptionTriggerList","responses":{"200":{"description":"Success response. Data could be an object instead of a list when one value is returned","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"success","nullable":false},"type":{"type":"string","nullable":false},"moreAfter":{"type":"string","nullable":true},"data":{"nullable":false,"type":"array","items":{"type":"object","properties":{"publicId":{"maxLength":36,"minLength":36,"nullable":false,"type":"string","format":"uuid"},"lastTry":{"nullable":true,"type":"string","format":"date-time"},"nextTry":{"nullable":true,"type":"string","format":"date-time"},"ok":{"nullable":false,"type":"boolean"},"retrying":{"nullable":false,"type":"boolean"},"status":{"maxLength":100,"minLength":2,"nullable":true,"type":"string"},"tryCount":{"maximum":4294967295,"nullable":false,"type":"integer","format":"int32"},"subscription":{"nullable":false,"type":"object","properties":{"publicId":{"nullable":false,"type":"string"}}}}}}}}}}},"4XX":{"$ref":"#/components/responses/4XXErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/apiVersion"},{"$ref":"#/components/parameters/apiApplication"},{"$ref":"#/components/parameters/apiBrandingOptional"},{"$ref":"#/components/parameters/fieldsParameter"},{"$ref":"#/components/parameters/filtersParameter"},{"required":true,"name":"publicId","in":"path","schema":{"type":"string"}}],"security":[{"bearerToken":[]}]}}},"components":{"parameters":{"apiVersion":{"required":true,"description":"Version of the API to use","name":"Api-Version","in":"header","schema":{"type":"integer","format":"int32","enum":[2]}},"apiApplication":{"required":true,"description":"Get your Application ID via support@ixon.cloud","name":"Api-Application","in":"header","schema":{"type":"string","pattern":"^[0-9a-zA-Z]{12}$"}},"apiBrandingRequired":{"required":true,"description":"Domain that provides the branding","name":"Api-Branding","in":"header","schema":{"type":"string","pattern":".+(\\..[^.]+)"}},"apiBrandingOptional":{"required":false,"description":"Domain that provides the branding","name":"Api-Branding","in":"header","schema":{"type":"string","pattern":".+(\\..[^.]+)"}},"fieldsParameter":{"required":false,"description":"Fields to select. Use \"*\" for all the top-level fields. Or check the \"Success response\" below for other fields.\n\nTo get the fields of a subresource do subresource.field or for multiple fields of one subresource do subresource(field,field)","name":"fields","in":"query","schema":{"type":"array","items":{"type":"string"}}},"filtersParameter":{"required":false,"description":"Filter the returned item(s). Format: operator(column,val)\n\nPossible operators are: lt, less, lte, lessorequal, eq, equals, ne, differs, gt, greater, gte, greaterorequal, in, ni, isnull, isnotnull, between, contains.\n\nExample: eq(publicId,\"publicId_val\")","name":"filters","in":"query","schema":{"type":"array","items":{"type":"string"}}},"apiCompany":{"required":true,"description":"PublicId of the company","name":"Api-Company","in":"header","schema":{"type":"string","pattern":"^(\\d{4}-){4}\\d{4}$"}}},"responses":{"4XXErrorResponse":{"description":"4XX error response","content":{"application/json":{"schema":{"type":"object","required":["status","type","data"],"properties":{"status":{"type":"string","default":"error","nullable":false},"type":{"type":"string","default":"Error","nullable":false},"data":{"nullable":false,"type":"array","items":{"$ref":"#/components/schemas/4XXErrorSchema"}}}}}}}},"schemas":{"4XXErrorSchema":{"type":"object","properties":{"message":{"nullable":false,"type":"string"},"propertyName":{"nullable":true,"type":"string"},"listIndex":{"nullable":true,"type":"integer","format":"int32"}},"required":["message"]}},"securitySchemes":{"bearerToken":{"type":"http","description":"Bearer token created by the endpoint \"POST AccessTokenList\"","scheme":"bearer"}}},"x-samples-languages":["curl","ruby","javascript","python","powershell"]}